Add discussion of doctesting interactive code examples.

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

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

評価

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

調査の方向性

Documentation/Style Guide/Code Examples と doctest のドキュメント、特に対話的な例とディレクティブに関するガイダンスを読む。Docs/Doctest CI チェックと参照されている議論を確認して現在のポリシーを把握し、その後、既存のセクションまたはその直後の新しいセクションに簡潔な概要を追加する。ガイドで、対話的な例に対して期待される doctest の動作と関連するディレクティブが説明されていれば完了とする。

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

説明

topic-documentation topic-test type-feature

There have been various discussions about doctesting interactive code examples in the python docs. The consensus has been that it is desirable that they pass. Indeed, CI currently has a (pass-not-required) Tests / Docs / Doctest. (But it seems to be setup to be excessively lenient, passing many errors that are normally caught. Intended? Bug?) There has been additional discussion about use of particular features, such as doctest directives. An example from the doc:

The [ELLIPSIS](https://docs.python.org/3/library/doctest.html#doctest.ELLIPSIS) directive
gives a nice approach for the last example:
>>> C()  # doctest: +ELLIPSIS
<C object at 0x...>

Other people may remember such discussions better. In any case, a summary of current policy should be added either in
Documentation / Style Guide /Code Examples or in a new "Interactive Code Examples and Doctest" section immediately after.

主要言語
Python
スター
2.1k
フォーク
1k
平均マージ
2日 12時間
マージ済み PR（30日）
12

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

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

はじめの一歩

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

python/devguide のほかの issue

python/devguide の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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