python / python/mypy

Should show_error_code_links be documented?

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

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

documentation
主要言語
Python
スター
20.6k
フォーク
3.3k
PR マージ指標
PR 指標を取得中

説明

Documentation

show_error_code_links is undocumented. Should it be documented? (show_error_codes is deprecated, but I don't think this is related)

https://github.com/SchemaStore/schemastore/issues/3467

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

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

はじめの一歩

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

調査の方向性

まず show_error_code_links のドキュメントまたは設定リファレンスを見つけ、次に非推奨の show_error_codes オプションでの扱いと比較し、リンクされている SchemaStore の issue を確認します。設定をドキュメント化すべきかどうかを判断し、必要であれば適切なドキュメントを追加すれば完了です。

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

評価

技術スタック
python
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
35/100

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

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