graphql-python / graphql-python/graphene

Correct documentation and use of type hints

オープン
#1,454 コメント 1 件 リアクション 6 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

✨ enhancement 📖 documentation 🙋 help wanted
主要言語
Python
スター
8.2k
フォーク
818
PR マージ指標
30日以内にマージされた PR はありません

説明

We should upgrade graphene to use modern type hints. In that process, type hints should be removed from the class/method documentation to have the code as the single source of truth for typing.
We can use https://github.com/tox-dev/sphinx-autodoc-typehints to automatically add type hints back into the docs.

PRs addressing this issue should at least fix the entire file they are contributing to reduce double-checking effort and streamline the process.

Known issues:
#1100 , see #1282 (Query on schema)

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、影響を受ける Python ファイルとドキュメント設定を確認し、次に #1100 と #1282 の既知の問題を読んでください。提案されているドキュメント機構として sphinx-autodoc-typehints を使用します。完了とは、最新の型ヒントが唯一の正しい情報源となり、重複したヒントがドキュメントから削除され、各コントリビュートされたファイルが完全な状態になることを意味します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
backend-api-design, documentation
issue の種類
リファクタリング
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
32/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。