python / python/docs-community
ABC documentation needs more details on usage
オープン
まだ誰も着手していません。
question
- 主要言語
- Makefile
- スター
- 55
- フォーク
- 26
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
I am trying to use Abstract Base Classes. But I find the documentation lacking on several points that makes the matter too 'abstract'.
For example. There is no explanation on making abstract objects mandatory by using exceptions
Or how to implement Iterable abstract bsse class that can be inherited from and still be usable.
Can someone shed more light onto this so that the documentation is more accessible?
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず Abstract Base Classes のドキュメントを見つけ、抽象オブジェクト、例外、Iterable の継承について現在どの程度カバーされているかを確認します。完了の条件は、ドキュメントで要求された使用パターンが明確に説明され、読者が例を利用しやすくなっていることです。issue では特定のファイルやテストは指定されていません。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 35/100