Use google-style docstrings #147
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
Release 0.12.7
Release 0.12.8
Converted all docstrings in the project from RST/Sphinx style to Google style: - geofetch/geofetch.py: Converted class and method docstrings for Geofetcher - geofetch/utils.py: Converted function and class docstrings - geofetch/finder.py: Converted Finder class docstrings - geofetch/cli.py: Converted CLI function docstrings - geofetch/sraconvert.py: Converted utility function docstrings All docstrings now follow the Google style format with Args, Returns, and Raises sections as appropriate.
There was a problem hiding this comment.
Pull Request Overview
This PR updates all docstrings across the geofetch codebase from reStructuredText (reST) format to Google-style docstrings, improving consistency and readability. The conversion follows Python's modern documentation standards by using the Args, Returns, and Raises sections.
- Converted all function/method docstrings from reST to Google-style format
- Standardized single-line summaries to be on the same line as opening triple quotes
- Updated docstring descriptions to use proper capitalization and punctuation
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| geofetch/utils.py | Converted all utility function docstrings from reST to Google-style format |
| geofetch/sraconvert.py | Updated docstrings for safe_echo and uniqify functions |
| geofetch/geofetch.py | Converted all Geofetcher class method docstrings to Google-style, including constructor and main workflow methods |
| geofetch/finder.py | Updated all Finder class method docstrings to Google-style format |
| geofetch/cli.py | Converted command-line parsing function docstrings and removed trailing whitespace |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
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.
Use google-style docstrings