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

Fill in docstrings for functions in config.py and tests/utils.py #377

Merged
merged 4 commits into from
Jan 16, 2025

Conversation

singlesp
Copy link
Contributor

Relates to #358. I will next work on docstrings only in cubids src code.

Changes proposed in this pull request

  • updates docstrings for config.py and tests/utils.py

Documentation that should be reviewed

  • config.py and tests/utils.py

@tsalo tsalo added the documentation Improvements or additions to documentation label Jan 15, 2025
@tsalo tsalo self-requested a review January 16, 2025 15:05
Copy link
Member

@tsalo tsalo left a comment

Choose a reason for hiding this comment

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

The docstrings look solid, but I prefer to have the summary line on the same line as the quotes. E.g.,

"""Do something.

...
"""

instead of

"""
Do something.

...
"""

@singlesp
Copy link
Contributor Author

thanks @tsalo - made the changes

@tsalo tsalo changed the title Docstrings Fill in docstrings for functions in config.py and tests/utils.py Jan 16, 2025
Copy link
Member

@tsalo tsalo left a comment

Choose a reason for hiding this comment

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

LGTM! I changed the PR title to be a bit clearer about the scope of the changes.

@singlesp singlesp merged commit 9a4e9cd into main Jan 16, 2025
10 checks passed
@singlesp singlesp deleted the docstrings branch January 16, 2025 15:59
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

Successfully merging this pull request may close these issues.

2 participants