Update docstring format #584
Open
Conversation
This file contains hidden or 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
- Added module-level docstrings to `bg_atlas.py`, `cli.py`, `core.py`, `descriptors.py`, `list_atlases.py`, `structure_class.py`, `structure_tree_util.py`, `update_atlases.py`, and `utils.py` for better clarity. - Improved existing docstrings for various methods to follow consistent formatting and provide clearer descriptions. - Removed unnecessary blank lines in several files to improve code readability.
- Updated docstrings in `annotation_utils.py`, `mesh_utils.py`, `structure_json_to_csv.py`, `structures.py`, `validate_atlases.py`, and `wrapup.py` for consistency and clarity. - Improved formatting and added missing punctuation to enhance readability. - Added module-level docstrings where necessary to provide context for each module's purpose.
- Updated docstrings in various atlas generation scripts to improve consistency and clarity. - Added missing punctuation and standardized return section formatting for better readability. - Removed unnecessary blank lines to streamline the code structure.
|
Awesome, thank you for this and the updates on your other PRs @thisisrick25 - I will make time to review next week! |
|
Thank you @alessandrofelder |
* Allows access to additional_references names via additional_references.keys() * Updated tests * Checks if key in references list before querying dictionary * Adds test for fetching keys before additional reference data
…le modules - Changed "Arguments" to "Parameters" for uniformity in docstring headers. - Improved descriptions and added missing details in parameter sections for better understanding. - Enhanced readability by standardizing formatting and punctuation in docstrings across `cli.py`, `structure_class.py`, `structure_tree_util.py`, `update_atlases.py`, and `utils.py`.
- Updated module-level docstrings in `metadata_utils.py`, `stacks.py`, `structure_json_to_csv.py`, `structures.py`, `validate_atlases.py`, and `volume_utils.py` to provide clearer context and purpose. - Improved parameter descriptions and standardized formatting in function docstrings for better readability. - Added missing details in return sections and raised exceptions to enhance documentation quality.
- Added module-level docstrings to `bg_atlas.py`, `cli.py`, `core.py`, `descriptors.py`, `list_atlases.py`, `structure_class.py`, `structure_tree_util.py`, `update_atlases.py`, and `utils.py` for better clarity. - Improved existing docstrings for various methods to follow consistent formatting and provide clearer descriptions. - Removed unnecessary blank lines in several files to improve code readability.
- Updated docstrings in `annotation_utils.py`, `mesh_utils.py`, `structure_json_to_csv.py`, `structures.py`, `validate_atlases.py`, and `wrapup.py` for consistency and clarity. - Improved formatting and added missing punctuation to enhance readability. - Added module-level docstrings where necessary to provide context for each module's purpose.
- Updated docstrings in various atlas generation scripts to improve consistency and clarity. - Added missing punctuation and standardized return section formatting for better readability. - Removed unnecessary blank lines to streamline the code structure.
…le modules - Changed "Arguments" to "Parameters" for uniformity in docstring headers. - Improved descriptions and added missing details in parameter sections for better understanding. - Enhanced readability by standardizing formatting and punctuation in docstrings across `cli.py`, `structure_class.py`, `structure_tree_util.py`, `update_atlases.py`, and `utils.py`.
- Updated module-level docstrings in `metadata_utils.py`, `stacks.py`, `structure_json_to_csv.py`, `structures.py`, `validate_atlases.py`, and `volume_utils.py` to provide clearer context and purpose. - Improved parameter descriptions and standardized formatting in function docstrings for better readability. - Added missing details in return sections and raised exceptions to enhance documentation quality.
…25/brainglobe-atlasapi into thisisrick25/issue582
- Clarified the description of the method to enhance understanding of its functionality. - Updated parameter and return sections for consistency with the rest of the codebase. - Added details regarding caching behavior and handling of missing references.
- Updated parameter and return sections to use consistent terminology and formatting. - Improved descriptions for better understanding of function inputs and outputs. - Clarified behavior when handling lists of structures in both methods.
|
@alessandrofelder can you review this PR? |
|
Sorry @thisisrick25 - I'm sure it's a good PR, I just still (😢) haven't managed to make time for this. It's on my list. Thanks for bearing with. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #582
Pydocstyle error codes that are fixed in this PR:
Also improved the literature of the docstrings.