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