python / python/cpython

Capsule API usage docs are incompatible with module reloading (etc)

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

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

3.13 3.14 3.15 docs type-bug
主要言語
Python
スター
77.2k
フォーク
36k
PR マージ指標
PR 指標を取得中

説明

BPO 32459
Nosy @brettcannon, @ncoghlan, @encukou, @ericsnowcurrently, @Dormouse759

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2017-12-31.05:27:01.669>
labels = ['type-bug']
title = 'Capsule API usage docs are incompatible with module reloading (etc)'
updated_at = <Date 2018-01-09.10:25:18.773>
user = 'https://github.com/ncoghlan'

bugs.python.org fields:

activity = <Date 2018-01-09.10:25:18.773>
actor = 'petr.viktorin'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = []
creation = <Date 2017-12-31.05:27:01.669>
creator = 'ncoghlan'
dependencies = []
files = []
hgrepos = []
issue_num = 32459
keywords = []
message_count = 1.0
messages = ['309266']
nosy_count = 5.0
nosy_names = ['brett.cannon', 'ncoghlan', 'petr.viktorin', 'eric.snow', 'Dormouse759']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue32459'
versions = []

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

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

はじめの一歩

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

調査の方向性

まず Capsule API の使用方法のドキュメントを読み、モジュールをリロードしたときにその例がどのように動作するかを調べます。互換性がなくなるドキュメント化された使用方法を特定し、モジュールのリロード後も有効であり続けるようにドキュメントを更新して、改訂した例を検証します。

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

評価

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

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

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