python: change function descriptions to follow docstring convention #468
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
cmoussa1
added
documentation
Problem: The function descriptions for a number of functions in the Python bindings do not follow PEP 257: Docstring Conventions. https://peps.python.org/pep-0257/ Update the misformatted function description to follow docstring convention.
cmoussa1
force-pushed
the
add.py.docstrings
branch
from
2d71bdd
to
dcbaba3
Compare
jameshcorbett
approved these changes
Jul 11, 2024
|
finally free!! setting MWP here |
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.
Problem
The function descriptions for a number of functions in the Python bindings do not follow PEP 257: Docstring Conventions.
This PR updates the misformatted function description to follow docstring convention.