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