SymPy 项目

本页详细介绍了 Google 文档季收录的技术文案项目。

项目摘要

开源组织：
SymPy
技术文档工程师：
Soumi7
项目名称：
docstring 之间的一致性 - Sympy 文档
项目时长：
标准时长（3 个月）

Project description

摘要：

Sympy 文档的当前状态和之前的工作：

  • 为 SymPy 创建官方样式指南的工作已经完成。

  • Lauren Glattly 的 GSoD 项目创建了 SymPy docstring 的风格指南，可参阅 SymPy 文档风格指南。

  • 修改了 Special 子模块和 solvers.py 文件中的 docstring，以始终遵循新样式指南的准则

  • 代码库中的所有其他文档字符串仍然需要修改，以符合新样式指南。

建议的工作：

  • SymPy 中的大多数文档字符串仍不符合最新的样式指南。此项目的目标是更新整个 SymPy 中的 docstring，使其符合本指南的要求。

  • 我与导师讨论了该项目。以下是该讨论的链接。

  • 我们决定，修改 sympy 代码库中的文档字符串以遵循最新的样式指南是一项艰巨的任务，因此该项目应仅限于此。

  • 在该项目中，我的工作包括实现新指南以更新现有 docstring，同时收集和解决其他不一致性问题，例如语言使用或术语。

  • 您可以稍后或作为单独的任务更改或确定现有子部分的顺序。

  • 通过添加更多示例以及“添加参数”部分，演示向参数传递不同值时结果的差异。

  • 继续向“注意事项和误区”部分添加棘手的示例。

贡献： - #17887：处理了问题 #17887：在 Special 子模块中添加了缺少的 docstring 部分。我为由 L 编辑的 Specials 子模块的部分函数添加了缺少的“参数和示例”部分。Glattly，以遵循最新的风格指南，并作为未来文档注释的模板。

以下是我合并的 PR 的链接：https://github.com/sympy/sympy/pull/19334

  • #19591：问题 #19591 用于跟踪文档样式指南。我添加了一个 PR 来修改 core.sympify docstring，以遵循最新的样式指南。我添加了有关不同参数用法的结构化说明和示例。

以下是 PR 的链接：https://github.com/sympy/sympy/pull/19613

项目目标

时间轴 8 月 17 日之前：

  • 继续为组织做出贡献。
  • 熟悉用户文档和 sympy 的当前版本。
  • 了解在实现项目时有用的技巧。

社区凝聚：（2020 年 8 月 17 日 - 9 月 13 日）

  • 设置沟通渠道和时间（由于时差）。
  • 优化我的目标，并为双方设定预期。
  • 讨论模块的更新顺序。
  • 确定修改模块的顺序，使其符合最新的文档字符串样式指南。

文档征集期（2020 年 9 月 14 日至 2020 年 11 月 30 日）：

  • 设定每周要达成的目标，最好每周或多次更新一个模块或子模块的文档字符串。

  • 对于所有这些模块，我的首要目标是添加缺少的部分并重构文档注释，以遵循最新的样式指南。这将包括演示向参数传递不同值时获得的不同结果。所有棘手的输出都应添加到“注意事项和陷阱”部分。

  • 第 1 周（9 月 14 日至 9 月 21 日）：核心

  • 第 2 周（9 月 22 日至 9 月 29 日）：函数：组合子模块

  • 第 3 周（9 月 30 日 - 10 月 6 日）：函数

  • 第 4 周（10 月 7 日 - 10 月 14 日）：简化加密

  • 第 5 周（10 月 15 日至 10 月 21 日）：代数

  • 第 6 周（10 月 22 日至 10 月 29 日）：Holonomic：Operations 子模块

  • 第 7 周（10 月 30 日至 11 月 7 日）：积分模块 (integrals.integrals)，使用 Meijer G 函数计算积分

  • 第 8 周（11 月 8 日至 11 月 15 日）：物理、类别模块末尾的函数、代码生成模块、子模块专题

  • 第 9 周（11 月 16 日至 11 月 23 日）：物理学、类别模块末尾的函数、代码生成模块、特殊子模块

  • 第 10 周（11 月 24 日至 11 月 30 日）：陷阱和误区部分

  • 2020 年 11 月 30 日至 12 月 5 日 18:00（世界协调时间）：提交最终项目和撰写报告

  • 2020 年 12 月 3 日至 10 日 18:00（世界协调时间）：提交项目成功经验和与导师合作的经验

  • 在与导师进一步讨论后，此处提及的模块顺序可能会发生变化。

  • 根据导师的建议，我将先重点更新那些更易于更新的模块，然后再更新复杂的模块。

为什么我适合参与此项目？

  • 我认为自己非常适合这项工作，因为我曾在计算机科学领域从事过技术写作，并且精通 git 和 GitHub。

  • 我已提交 PR 来将文档更新为 sympy 中的最新样式指南，这些 PR 已成功合并，因此我对工作流程充满信心，并会定期做出贡献。

  • 刚开始贡献时，我遇到了一些错误。我终于习惯了每次提交更改前运行测试和构建文档，因为这非常重要。

  • 我非常乐意为此项目做出贡献，并期待着这一点。