Argument clinic: outdated tutorial

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

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

評価

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

調査の方向性

リンクされたArgument Clinicチュートリアルを開き、「First, ensure both places use the same argument-parsing function.」で始まるセクションを確認してください。その主張を、Tools/clinic/clinic.pyの現在の出力および動作と比較してください。このセクションが現在の実装を正確に説明し、古いPyArg_ParseTuple*()ワークフローを提示しなくなった時点で、ドキュメントは完成です。

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

説明

topic-dev process type-bug

Documentation

The tutorial for Argument Clinic in the devguide contains an outdated section. It still describes the early implementation that used to generate calls to PyArg_ParseTuple*() functions. This is no longer the case.

The affected section starts with "First, ensure both places use the same argument-parsing function." and goes for a few paragraphs until "If any of these items differ in any way, adjust your Argument Clinic function specification and rerun Tools/clinic/clinic.py until they are the same."

Given that the output is now very different, this is quite confusing to read. The section probably needs to be completely rewritten.

CC @AlexWaygood @erlend-aasland

主要言語
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 を短くまとめたダイジェスト。