update docstrings google style #558
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
- Updated all RST-style docstrings to Google-style format - Converted :param/:return/:raise to Args:/Returns:/Raises: sections - utils.py: 44 parameter annotations converted - conductor.py: 35 parameter annotations converted
…ugins.py - exceptions.py: 1 docstring converted - const.py: 1 docstring converted - plugins.py: 3 docstrings converted - All RST-style :param/:return annotations updated to Args:/Returns: format
- parser_types.py: 2 docstrings converted - command_models/arguments.py: 1 docstring converted - command_models/commands.py: 2 docstrings converted - All RST-style annotations updated to Google-style format
- divvy.py: 16 docstrings converted - looper.py: 11 docstrings converted - pipeline_interface.py: 10 docstrings converted - project.py: 24 docstrings converted - processed_project.py: 5 docstrings converted - cli_pydantic.py: 1 docstring converted - cli_divvy.py: 1 docstring converted All RST-style docstrings (:param/:return/:raise) have been converted to Google-style format (Args:/Returns:/Raises:) with proper formatting and capitalization.
Contributor
Author
|
@copilot Can you confirm that none of the meaning was changed or no incorrect hallucinations were introduced. |
There was a problem hiding this comment.
Pull Request Overview
This PR converts docstrings from reStructuredText (reST) format to Google-style docstrings across multiple Python files in the looper codebase. The conversion maintains the same semantic information while improving readability and following modern Python documentation standards.
Key changes:
- Converted all function, class, and method docstrings from reST format (
:param:,:return:,:raise:) to Google style (Args:,Returns:,Raises:) - Improved formatting consistency with proper capitalization and punctuation
- Maintained all parameter types, descriptions, and return value documentation
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| looper/utils.py | Converted 20+ function docstrings from reST to Google style |
| looper/project.py | Updated class and method docstrings throughout the Project class |
| looper/processed_project.py | Converted docstrings for path population functions |
| looper/plugins.py | Updated plugin function docstrings to Google style |
| looper/pipeline_interface.py | Converted PipelineInterface class and method docstrings |
| looper/parser_types.py | Updated argument parser type function docstrings |
| looper/looper.py | Converted Executor subclass and helper function docstrings |
| looper/exceptions.py | Updated exception class docstrings |
| looper/divvy.py | Converted ComputingConfiguration class and method docstrings |
| looper/const.py | Updated utility function docstrings |
| looper/conductor.py | Converted SubmissionConductor and helper function docstrings |
| looper/command_models/commands.py | Updated Command class and function docstrings |
| looper/command_models/arguments.py | Converted Argument class docstrings |
| looper/cli_pydantic.py | Updated CLI processing function docstrings |
| looper/cli_divvy.py | Converted argument parser builder docstring |
💡 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>
…ANoYLk6KK1hErAwMz
nsheff
deleted the
claude/update-docstrings-google-style-011CUqZANoYLk6KK1hErAwMz
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.
No description provided.