Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docstrings across metasyn #223

Open
3 of 4 tasks
Samuwhale opened this issue Dec 11, 2023 · 0 comments
Open
3 of 4 tasks

Update docstrings across metasyn #223

Samuwhale opened this issue Dec 11, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Samuwhale
Copy link
Collaborator

Samuwhale commented Dec 11, 2023

Currently it states that to_dict must be implemented in derived classes from Base (distribution), but that is not the case. It should be changed to state that _param_dict , default_distribution and _param_schema are required instead.

In general, it would be nice to improve the docstrings - this will also make the automatically generated API on the readthedocs easier to understand.

@Samuwhale Samuwhale added bug Something isn't working good first issue Good for newcomers and removed bug Something isn't working good first issue Good for newcomers labels Dec 11, 2023
@Samuwhale Samuwhale self-assigned this Dec 12, 2023
@Samuwhale Samuwhale changed the title Update docstring in BaseDistribution Update docstrings across metasyn Dec 12, 2023
@vankesteren vankesteren added the documentation Improvements or additions to documentation label Jan 31, 2024
@qubixes qubixes added this to the Metasyn 1.1 milestone Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants