SymPy 项目

本页面包含有关 Google 文档季可接受的技术写作项目的详细信息。

项目摘要

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

Project description

摘要：

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

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

  • Lauren Glattly 的 GSoD 项目为 SymPy 文档字符串创建了样式指南，您可以在“SymPy 文档样式指南”中找到该指南。

  • 对 Special 子模块和 solrs.py 文件中的文档字符串进行了编辑，以始终遵循新样式指南的准则

  • 整个代码库中的所有其他文档字符串仍需根据新的样式指南进行编辑。

工作建议：

  • SymPy 中的大多数文档字符串仍然不遵循最新的样式指南。此项目的目标是更新整个 SymPy 的文档字符串，以遵循本指南。

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

  • 他们决定在 Sympy 的代码库中修改文档字符串以遵循最新样式指南，这是一项重大任务，因此项目应仅限于此。

  • 我参与该项目的工作涉及到实施新指南来更新现有文档字符串，同时收集并解决其他不一致问题，例如语言使用或术语。

  • 现有子部分的顺序可以稍后更改或决定，也可以作为单独的任务进行。

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

  • 请继续在“陷阱和误区”部分添加棘手的示例。

贡献内容： - #17887：解决了问题 17887：在 Special 子模块中添加了缺少的文档字符串部分。我在 L 编辑的“Specials”子模块的一些函数中添加了缺少的“参数和示例”部分。愿意遵循最新风格指南，并成为未来文档字符串的典范。

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

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

以下是 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 日）：Diophantine

  • 第 6 周（10 月 22 日至 10 月 29 日）：“全息：操作”子模块

  • 第 7 周（10 月 30 日至 11 月 7 日）：积分模块 (integrals.integrals)，使用梅杰 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 中的最新样式指南，而且这些文档已成功合并，因此我对工作流程充满信心，并会定期做出贡献。

  • 起初，当我开始做贡献时，遇到了一些错误。最后，我终于习惯了每次运行测试和构建文档，然后再提交更改，因为这一点非常重要。

  • 我非常乐意为这个项目做贡献，期待着与您合作。