Skip to content

Commit

Permalink
Fix doc typos and minor clarification (#207)
Browse files Browse the repository at this point in the history
* wip

* wip

* wip
  • Loading branch information
ronanstokes-db committed Apr 18, 2023
1 parent b464bd9 commit 54d7948
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
8 changes: 7 additions & 1 deletion docs/source/DISTRIBUTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,13 @@ The following distributions are supported:
- Exponential distribution

> Note the `distribution` option will have no effect for values that are not randomly generated as
> per use of the `random` option
> per use of the `random` option.
>
> For values generated randomly, continuous distributions can still be used with discrete values such as strings
> as the underlying random numbers used to select the appropriate discrete values will be drawn from the specified
> distribution. So, for discrete values, the frequency of occurrence of particular values should conform approximately
> to the underlying distribution.

### Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/source/generating_from_existing_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For more information, see :data:`~dbldatagen.data_analyzer.DataAnalyzer`
Analyzing the data to be synthesized
------------------------------------

You can use the ``summarizeToDf()`` method to generate a summary analysis of a dataframe.
You can use the ``summarizeToDF()`` method to generate a summary analysis of a dataframe.

Example:

Expand All @@ -32,7 +32,7 @@ Example:
analyzer = dg.DataAnalyzer(sparkSession=spark, df=dfSource)
display(analyzer.summarizeToDf())
display(analyzer.summarizeToDF())
Generating code to produce the synthetic data set
-------------------------------------------------
Expand Down

0 comments on commit 54d7948

Please sign in to comment.