Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Possible naming improvements

オープン
  • 何か問題がありますか？
#73 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
リファクタリング
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
python
領域
tooling

調査の方向性

まず、issue で指定されている公開エントリポイントを確認します: pyannotate_runtime、collect_types.init_types_collection()、resume()、dump_stats()、および提案されている start()、stop()、dump()。要求されている API の統合と初期化の変更が意図されたものかどうかを判断し、実装前に最終的な命名と import の動作を決定します。

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

説明

I was a bit surprised when approaching the package by the complexity of the naming.

What surprised me :

  1. the tool is named pyannotate but you must import pyannotate_runtime to use it
  2. collect_types.init_types_collection() ? Does the name really need to be that long ? Do we really need to explicitly init by the way ? Why not initialize on first resume() ?
  3. dump_stats() is ok but dump() is good too

Suggestions :

  • allow to import directly from pyannotate
  • 3 functions only : start(), stop(), dump()
  • initialize on first start() or rename init_types_collection() to init()

By the way, I am looking into contributing to pyannotate.

主要言語
Python
スター
1.4k
フォーク
59
30日以内にマージされた PR はありません

環境構築

はじめの一歩

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

dropbox/pyannotate のほかの issue

dropbox/pyannotate の issue をすべて見る

似ている issue

Python の issue をもっと見る

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

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