-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improved docstrings at a class level (#234)
* updates docstrings in main metasyn package * add base and categorical class docstrings * Change configuration from ini to toml * Enable privacy to be set * Add data-free option to generate data. * Update according to discussion * Mostly working implementation * Remove old code * Fix the tests * Fix ruff * Rework VarConfig * Fix pylint issues * Fix mistake in error handling * Update tutorial * Fix pydocstyle issues * Fix mypy issues * Fix cyclic import * Remove mypy errors * Improve tests for the CLI * Add tests for configurations * Quickly fix some linting issues in testing * Update documentation according to changes * There was a reason for the comments * Uncommitted code * Update docs/source/usage/cli.rst Co-authored-by: Samuel <[email protected]> * Update metasyn/config.py Co-authored-by: Samuel <[email protected]> * Update metasyn/config.py Co-authored-by: Samuel <[email protected]> * Update metasyn/util.py Co-authored-by: Samuel <[email protected]> * minor changes * fix test errors * fix sphinx * Revert "fix sphinx" This reverts commit da5e7e8. * Fix sphinx (without irrelevant files) * comment based updates * more comment based changes * Update docs/source/api/metasyn.distribution.rst Co-authored-by: qubixes <[email protected]> --------- Co-authored-by: Raoul Schram <[email protected]> Co-authored-by: qubixes <[email protected]>
- Loading branch information
1 parent
6c7c0f5
commit 275b5d7
Showing
11 changed files
with
154 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,10 @@ | ||
metasyn.demo package | ||
==================== | ||
Demo package | ||
============ | ||
|
||
.. automodule:: metasyn.demo | ||
:members: | ||
:undoc-members: | ||
:imported-members: | ||
:inherited-members: | ||
:private-members: | ||
:show-inheritance: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,70 +1,97 @@ | ||
metasyn.distribution package | ||
============================== | ||
Distribution package | ||
==================== | ||
|
||
.. automodule:: metasyn.distribution | ||
This package consists of several distribution modules. | ||
It also includes :mod:`metasyn.distribution.base` module, which forms the basis of all distributions. | ||
|
||
Base module | ||
^^^^^^^^^^^ | ||
|
||
.. automodule:: metasyn.distribution.base | ||
:members: | ||
:undoc-members: | ||
:inherited-members: | ||
:private-members: | ||
:show-inheritance: | ||
|
||
Submodules | ||
---------- | ||
Categorical module | ||
^^^^^^^^^^^^^^^^^^ | ||
|
||
metasyn.distribution.base module | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
.. automodule:: metasyn.distribution.base | ||
.. automodule:: metasyn.distribution.categorical | ||
:members: | ||
:undoc-members: | ||
:inherited-members: | ||
:private-members: | ||
:show-inheritance: | ||
|
||
metasyn.distribution.categorical module | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
Constant module | ||
^^^^^^^^^^^^^^^ | ||
|
||
.. automodule:: metasyn.distribution.categorical | ||
.. automodule:: metasyn.distribution.constant | ||
:members: | ||
:undoc-members: | ||
:inherited-members: | ||
:private-members: | ||
:show-inheritance: | ||
|
||
metasyn.distribution.continuous module | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
Continuous module | ||
^^^^^^^^^^^^^^^^^ | ||
|
||
.. automodule:: metasyn.distribution.continuous | ||
:members: | ||
:undoc-members: | ||
:inherited-members: | ||
:private-members: | ||
:show-inheritance: | ||
|
||
metasyn.distribution.datetime module | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
Datetime module | ||
^^^^^^^^^^^^^^^ | ||
|
||
.. automodule:: metasyn.distribution.datetime | ||
:members: | ||
:undoc-members: | ||
:inherited-members: | ||
:private-members: | ||
:show-inheritance: | ||
|
||
metasyn.distribution.discrete module | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
Discrete module | ||
^^^^^^^^^^^^^^^ | ||
|
||
.. automodule:: metasyn.distribution.discrete | ||
:members: | ||
:undoc-members: | ||
:inherited-members: | ||
:private-members: | ||
:show-inheritance: | ||
|
||
metasyn.distribution.faker module | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
Faker module | ||
^^^^^^^^^^^^ | ||
|
||
.. automodule:: metasyn.distribution.faker | ||
:members: | ||
:undoc-members: | ||
:inherited-members: | ||
:private-members: | ||
:show-inheritance: | ||
|
||
metasyn.distribution.regex module | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
NA module | ||
^^^^^^^^^ | ||
|
||
.. automodule:: metasyn.distribution.regex | ||
.. automodule:: metasyn.distribution.na | ||
:members: | ||
:undoc-members: | ||
:inherited-members: | ||
:private-members: | ||
:show-inheritance: | ||
|
||
Regex module | ||
^^^^^^^^^^^^ | ||
|
||
.. automodule:: metasyn.distribution.regex | ||
:members: | ||
:undoc-members: | ||
:inherited-members: | ||
:private-members: | ||
:show-inheritance: | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.