本页面包含 Google 文档季接受的技术写作项目的详细信息。
项目摘要
- 开源组织：
- SymPy
- 技术文档工程师：
- lglattly
- 项目名称：
- docstring 之间的一致性
- 项目时长：
- 标准时长（3 个月）
Project description
在本项目中，我将致力于使 SymPy 的 docstring 更加一致。
在与导师合作时，我会先确定代码库中文档注解的所需格式。然后，我会为整个代码库中的所有 docstring 创建文档格式指南，供其遵循。在该项目中，我还需要实施新指南来更新现有 docstring，同时收集和解决其他不一致的问题，例如语言使用或术语。我的导师和我一起决定如何处理这些额外的不一致性，最终的风格偏好也将添加到指南中。
该项目的最终目标是制定文档格式和样式指南，供开发者和贡献者使用，以帮助确保 SymPy 的 docstring 在现在和未来保持一致。