Convert docstrings to Google style format #235
Merged
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
v0.14.1 release
v0.14.2 release
v0.14.3 release
Release 0.14.4
v 0.14.5 release
Updated docstrings throughout the pypiper codebase from reStructuredText style (:param, :return, :raise) to Google-style format (Args:, Returns:, Raises:) for improved readability and consistency. Modified files: - pypiper/manager.py: Converted PipelineManager class and all 27+ methods - pypiper/pipeline.py: Converted Pipeline class and all methods - pypiper/utils.py: Converted 28+ utility functions - pypiper/stage.py: Converted Stage class and methods - pypiper/ngstk.py: Converted NGSTk class and 78+ methods - pypiper/exceptions.py: Converted UnknownPipelineStageError - pypiper/folder_context.py: Converted FolderContext class All conversions maintain original descriptions and documentation details while following Google-style documentation standards.
There was a problem hiding this comment.
Pull Request Overview
This PR modernizes the docstring format across the pypiper codebase by converting from reStructuredText (reST) format to Google-style docstrings. The changes affect multiple files including utils.py, stage.py, pipeline.py, ngstk.py, manager.py, folder_context.py, and exceptions.py.
Key changes:
- Converted parameter documentation from
:param type name:toArgs:section withname (type):format - Converted return documentation from
:return type:toReturns:section - Converted exception documentation from
:raise Exception:toRaises:section - Moved opening docstring quotes to same line as the summary sentence
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| pypiper/utils.py | Converted all function docstrings from reST to Google style |
| pypiper/stage.py | Updated class and method docstrings to Google style format |
| pypiper/pipeline.py | Modernized all pipeline-related docstrings |
| pypiper/ngstk.py | Converted NGSTk class and method docstrings |
| pypiper/manager.py | Updated PipelineManager docstrings to Google style |
| pypiper/folder_context.py | Converted context manager docstrings |
| pypiper/exceptions.py | Updated exception class docstrings |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
nsheff
deleted the
claude/update-docstrings-google-style-011CUqZJhqzgD9t3NY6VSpFx
branch
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.
Updated docstrings throughout the pypiper codebase from reStructuredText style (:param, :return, :raise) to Google-style format (Args:, Returns:, Raises:) for improved readability and consistency.
Modified files:
All conversions maintain original descriptions and documentation details while following Google-style documentation standards.