Streamline documentation style #3232
Merged
Conversation
This file contains 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
Adopt the Google docstrings style as the preferred way to document code. Update one of the existing docstrings to the new format, to showcase how it would look like. Enable the `napoleon` preprocessor in Sphinx, to be able to process Google style docstrings. Take the opportunity to make the copyright year dynamic, so we don't have to manually keep it up to date. Add a section about documentation to the contributors guide.
andy-stark-redis
approved these changes
May 15, 2024
vladvildanov
approved these changes
May 15, 2024
gerzse
added a commit
to gerzse/redis-py
that referenced
this pull request
Jul 11, 2024
Adopt the Google docstrings style as the preferred way to document code. Update one of the existing docstrings to the new format, to showcase how it would look like. Enable the `napoleon` preprocessor in Sphinx, to be able to process Google style docstrings. Take the opportunity to make the copyright year dynamic, so we don't have to manually keep it up to date. --------- Co-authored-by: Gabriel Erzse <gabriel.erzse@redis.com>
gerzse
added a commit
that referenced
this pull request
Jul 11, 2024
Adopt the Google docstrings style as the preferred way to document code. Update one of the existing docstrings to the new format, to showcase how it would look like. Enable the `napoleon` preprocessor in Sphinx, to be able to process Google style docstrings. Take the opportunity to make the copyright year dynamic, so we don't have to manually keep it up to date. --------- Co-authored-by: Gabriel Erzse <gabriel.erzse@redis.com>
vladvildanov
pushed a commit
that referenced
this pull request
Sep 27, 2024
Adopt the Google docstrings style as the preferred way to document code. Update one of the existing docstrings to the new format, to showcase how it would look like. Enable the `napoleon` preprocessor in Sphinx, to be able to process Google style docstrings. Take the opportunity to make the copyright year dynamic, so we don't have to manually keep it up to date. Add a section about documentation to the contributors guide. --------- Co-authored-by: Gabriel Erzse <gabriel.erzse@redis.com>
vladvildanov
pushed a commit
that referenced
this pull request
Sep 27, 2024
Adopt the Google docstrings style as the preferred way to document code. Update one of the existing docstrings to the new format, to showcase how it would look like. Enable the `napoleon` preprocessor in Sphinx, to be able to process Google style docstrings. Take the opportunity to make the copyright year dynamic, so we don't have to manually keep it up to date. Add a section about documentation to the contributors guide. --------- Co-authored-by: Gabriel Erzse <gabriel.erzse@redis.com>
vladvildanov
pushed a commit
that referenced
this pull request
Sep 27, 2024
Adopt the Google docstrings style as the preferred way to document code. Update one of the existing docstrings to the new format, to showcase how it would look like. Enable the `napoleon` preprocessor in Sphinx, to be able to process Google style docstrings. Take the opportunity to make the copyright year dynamic, so we don't have to manually keep it up to date. Add a section about documentation to the contributors guide. --------- Co-authored-by: Gabriel Erzse <gabriel.erzse@redis.com>
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.
Pull Request check-list
Please make sure to review and check all of these items:
NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.
Description of change
Adopt the Google docstrings style as the preferred way to document code. Update one of the existing docstrings to the new format, to showcase how it would look like.
Enable the
napoleonpreprocessor in Sphinx, to be able to process Google style docstrings.Take the opportunity to make the copyright year dynamic, so we don't have to manually keep it up to date.
Add a section about documentation to the contributors guide.