SymPy 项目
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- SymPy
- 技术文档工程师：
- lglattly
- 项目名称：
- docstring 之间的一致性
- 项目时长：
- 标准时长（3 个月）
Project description
在本项目中，我将致力于使 SymPy 的 docstring 更加一致。
在与导师合作时，我会先确定代码库中文档注解的所需格式。然后，我会为整个代码库中的所有 docstring 创建文档格式指南，供其遵循。在该项目中，我还需要实施新指南来更新现有 docstring，同时收集和解决其他不一致的问题，例如语言使用或术语。我的导师和我一起决定如何处理这些额外的不一致性，最终的风格偏好也将添加到指南中。
该项目的最终目标是制定文档格式和样式指南，供开发者和贡献者使用，以帮助确保 SymPy 的 docstring 在现在和未来保持一致。
如未另行说明，那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可。有关详情，请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC)：2025-07-25。
[null,null,["最后更新时间 (UTC)：2025-07-25。"],[[["\u003cp\u003eThis project focuses on improving the consistency of docstrings within the SymPy codebase.\u003c/p\u003e\n"],["\u003cp\u003eA documentation formatting and style guide will be created and implemented to standardize docstrings.\u003c/p\u003e\n"],["\u003cp\u003eThe guide will address inconsistencies in formatting, language, and terminology for developers and contributors.\u003c/p\u003e\n"],["\u003cp\u003eThe project is part of Google Season of Docs and will be completed over three months.\u003c/p\u003e\n"]]],["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"],null,["# SymPy project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\nProject summary\n---------------\n\nOpen source organization:\n: SymPy\n\nTechnical writer:\n: lglattly\n\nProject name:\n: Consistency across docstrings\n\nProject length:\n: Standard length (3 months)\n\nProject description\n-------------------\n\nFor this project, I would aim to bring greater consistency to the docstrings of SymPy.\n\nWorking 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.\n\nThe 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."]]
