SymPy project
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-11-08 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-08 UTC."],[[["This project focuses on improving the consistency of docstrings within the SymPy codebase."],["A documentation formatting and style guide will be created and implemented to standardize docstrings."],["The guide will address inconsistencies in formatting, language, and terminology for developers and contributors."],["The project is part of Google Season of Docs and will be completed over three months."]]],["The project aims to standardize SymPy's docstrings. The technical writer will collaborate with mentors to define a consistent docstring format and create a documentation guide. This guide will be used to update existing docstrings and address inconsistencies in language and terminology. Mentors and the writer will make editorial decisions about the language, and document them. The outcome is a comprehensive guide for maintaining consistency in SymPy's docstrings.\n"]]
