python / python/cpython

curses: initscr(), newterm(), start_color() and the screen type have no docstrings

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

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

docs topic-curses type-bug
主要言語
Python
スター
77.2k
フォーク
35.9k
PR マージ指標
PR 指標を取得中

説明

Bug report

curses.initscr(), curses.newterm() and curses.start_color() are Python wrappers of the C functions (they copy the ACS_*, LINES/COLS and COLORS/COLOR_PAIRS constants into the package), and the wrappers have no docstring, so help(curses.initscr) shows nothing although _curses.initscr is documented. The curses.screen type has no docstring either, unlike window, complexchar and complexstr.

Also, the docstring of _curses.initscr() says "Return a WindowObject", the name of the C struct rather than the Python type.

Linked PRs
  • gh-157547

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

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

はじめの一歩

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

調査の方向性

エントリポイント curses.initscr()、curses.newterm()、curses.start_color()、curses.screen から始め、それらのヘルプ出力を、ドキュメント化されている _curses.initscr()、window、complexchar、complexstr の型と比較します。ラッパーと screen 型に有用な docstring があり、_curses.initscr() が Python 型を正しく示していれば完了です。開始前に、リンクされている gh-157547 の作業を確認してください。

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

評価

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

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

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