swagger-api / swagger-api/swagger-codegen
[Python] fix docstring to comply with PEP 287
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
[Python] fix docstring to comply with PEP 287
The python template predominantly uses PEP 287 - reStructuredText (reST) format style docstrings for function documentation. However certain functions docstrings - namely in modules/swagger-codegen/src/main/resources/python/api.mustache and modules/swagger-codegen/src/main/resources/python/api_client.mustache - are in syntactic and or grammatical violation of the correct convention.
Useful links:
- https://peps.python.org/pep-0287/
- https://www.sphinx-doc.org/en/master/usage/domains/python.html#info-field-lists
I proposed a solution in pull request #12533
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with modules/swagger-codegen/src/main/resources/python/api.mustache and api_client.mustache, then compare their function docstrings with PEP 287 and the linked Sphinx info-field guidance. Review pull request #12533 for the proposed solution. Done means the affected docstrings follow the stated reStructuredText convention without syntactic or grammatical violations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100