Проект SymPy
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- СимПи
- Технический писатель:
- лглаттли
- Название проекта:
- Согласованность строк документации
- Длина проекта:
- Стандартная продолжительность (3 месяца)
Описание проекта
В этом проекте я хотел бы обеспечить большую согласованность строк документации SymPy.
Работая со своими наставниками, я сначала определил желаемое форматирование строки документации в базе кода. Затем я бы создал руководство по форматированию документации для всех строк документации в базе кода, которым нужно следовать. Моя работа над проектом также будет включать в себя внедрение нового руководства по обновлению существующих строк документации, а также сбор и устранение других несоответствий, таких как использование языка или терминов. Мои наставники и я вместе принимали редакционные решения о том, как справиться с этими дополнительными несоответствиями, и полученные стилистические предпочтения также были бы добавлены в руководство.
Конечной целью проекта будет руководство по форматированию и стилю документации, которое может использоваться как разработчиками, так и участниками, чтобы поддерживать согласованность строк документации SymPy сейчас и в будущем.
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0". Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[[["Прост для понимания","easyToUnderstand","thumb-up"],["Помог мне решить мою проблему","solvedMyProblem","thumb-up"],["Другое","otherUp","thumb-up"]],[["Отсутствует нужная мне информация","missingTheInformationINeed","thumb-down"],["Слишком сложен/слишком много шагов","tooComplicatedTooManySteps","thumb-down"],["Устарел","outOfDate","thumb-down"],["Проблема с переводом текста","translationIssue","thumb-down"],["Проблемы образцов/кода","samplesCodeIssue","thumb-down"],["Другое","otherDown","thumb-down"]],["Последнее обновление: 2025-07-25 UTC."],[],["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"]]
