SymPy プロジェクト

このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。

プロジェクトの概要

オープンソース組織:

SymPy

テクニカル ライター:

lglattly

プロジェクト名:

docstring 間の整合性

プロジェクトの長さ:

標準期間（3 か月）

プロジェクトの説明

このプロジェクトでは、SymPy のドキュメント文字列の一貫性を高めることを目指します。

メンターと協力して、まずコードベース内のドキュメント文字列に必要な形式を特定します。次に、コードベース全体のすべてのドキュメントの形式に関するガイドを作成します。このプロジェクトでは、新しいガイドを実装して既存のドキュメントを更新し、言語の使用や用語などの他の不整合を収集して対処することも含まれます。こうした追加の不整合をどのように処理するかについて、メンターと私が編集上の判断を行い、その結果得られたスタイル設定もガイドに追加されます。

このプロジェクトの最終的な目標は、デベロッパーとコントリビューターの両方が使用できるドキュメントのフォーマットとスタイルガイドを作成することであり、これにより、SymPy のドキュメントの整合性を今後も維持できます。