This page contains the details of a technical writing project accepted for Google Season of Docs.
Project summary
- Open source organization:
- SymPy
- Technical writer:
- lglattly
- Project name:
- Consistency across docstrings
- Project length:
- Standard length (3 months)
Project description
For this project, I would aim to bring greater consistency to the docstrings of SymPy.
Working with my mentors, I would first identify the desired formatting for a docstring in the codebase. I would then create a documentation formatting guide for all docstrings across the codebase to follow. My work on the project would also involve implementing the new guide to update existing docstrings, while collecting and addressing other inconsistencies such as language use or terms. My mentors and I would together make editorial decisions of how to handle these additional inconsistencies, and the resulting stylistic preferences would also be added to the guide.
The end goal of the project would be a documentation formatting and style guide which could be used by both developers and contributors to help maintain consistency in SymPy's docstrings now and into the future.