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

Improved module/package docstrings #226

Merged
merged 9 commits into from
Jan 8, 2024
Merged

Improved module/package docstrings #226

merged 9 commits into from
Jan 8, 2024

Conversation

Samuwhale
Copy link
Collaborator

This is a first step towards improving the docstrings. Proper docstrings will help the automatically generated API be more usable and informative, it will also help using the package itself.

Next step will be class and function docstrings. But for now, module level docstrings.

I have tried to keep them under 79 characters per line, but in some cases an exception had to be made.

@Samuwhale Samuwhale requested a review from qubixes January 4, 2024 12:03
Copy link
Member

@qubixes qubixes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot! I updated the PR a bit already to remove some linting errors. I really like the new docstrings, more descriptive, without being too verbose! I have added some small comments/suggestions, but nothing major.

metasyn/__init__.py Outdated Show resolved Hide resolved
metasyn/__init__.py Outdated Show resolved Hide resolved
metasyn/__init__.py Outdated Show resolved Hide resolved
metasyn/__init__.py Outdated Show resolved Hide resolved
metasyn/__main__.py Outdated Show resolved Hide resolved
metasyn/distribution/base.py Outdated Show resolved Hide resolved
metasyn/distribution/continuous.py Outdated Show resolved Hide resolved
metasyn/distribution/regex.py Outdated Show resolved Hide resolved
metasyn/testutils.py Outdated Show resolved Hide resolved
metasyn/var.py Show resolved Hide resolved
@Samuwhale
Copy link
Collaborator Author

I have applied the changes!

I will also create an issue to update the frontpage of the docs to reflect the content of the metasyn __init__.py, and to create an issue to potentially rename MetaVar to MetaSeries.

@Samuwhale Samuwhale force-pushed the better-docstrings branch 2 times, most recently from bf765b2 to cdd7e89 Compare January 5, 2024 12:18
Copy link
Member

@qubixes qubixes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now!

@Samuwhale Samuwhale merged commit 7dca1cb into main Jan 8, 2024
6 checks passed
@Samuwhale Samuwhale mentioned this pull request Jan 8, 2024
4 tasks
@qubixes qubixes deleted the better-docstrings branch February 19, 2024 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants