Translator API/misc improvements
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 30/100
- issue の種類
- リファクタリング
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- python
- 領域
- api, documentation
調査の方向性
まず translator モジュール、その抽象親クラス、実装クラス、AlleleTranslator._create_allele、および個々の from メソッドを確認します。これは幅広い要望リストなので、まず、ドキュメント、型注釈、fmt、kwargs、または引数のスコープのどの改善を意図しているのかを確認してください。作業を開始する前に、選択した項目について done の定義を決める必要があります。
索引モデルが issue の本文から書いたものです。
説明
A wishlist/brainstorm:
- Richer documentation and type annotation. This module is serving a lot of roles right now and some internal design decisions have been made out of necessity for fulfilling those roles, and as personnel come and go/the years go on and on, we might lose sight of why those decisions were made. Stronger documentation about the why of some of these choices would help prevent breakage down the road (and might also resolve some of my thoughts/concerns below). Type annotation should be easier and would be a good short term step.
- Constrain global
fmtvalues in an enum - Document
kwargsfor translator methods directly in the implementation classes. Currently they're all located within the abstract parent, which means that docs for each implementation e.g. show the user some irrelevant kwargs. - Make documentation for individual
_from_methods accessible. Right now there's a docstring that refers a user to look at them for more information, but they're private (leading underscore), so the user technically isn't supposed to be able to/can't easily find them, either withhelp()or in docs if we ever make them. - Not clear to me why args in
AlleleTranslator._create_alleleare kwargs -- if it's for flexibility between individual_from_fmtmethods, there are a few ways we could make valid args more explicit, either naming them all and giving them defaults, doing fmt-specific post-processing within the_from_fmtmethod, ...
- 主要言語
- Python
- スター
- 64
- フォーク
- 44
- 平均マージ
- 3日 2時間
- マージ済み PR（30日）
- 6
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ga4gh/vrs-python のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
ga4gh/vrs-python#540 · コメント 8 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 4/5 3〜5日 初心者へのやさしさ 42/100
ga4gh/vrs-python#669 ·
メンテナーはふだん 1 日以内に返信
-
test(ci): dont make live network requests対応中かも @theferrit32 が 12 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
ga4gh/vrs-python#659 · コメント 1 件 · リアクション 1 件 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
Add Relative Allele Normalization再び着手できるかも @korikuzma が 92 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
ga4gh/vrs-python#641 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
ga4gh/vrs-python#640 ·
メンテナーはふだん 1 日以内に返信
ga4gh/vrs-python の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
NousResearch/hermes-agent#140958 ·
メンテナーはふだん 1 日以内に返信
-
Bisect issue233186オープンbisect
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
dtcxzyw/llvm-bisect-service#548 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
sallowayma-git/IELTS-practice#248 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 65/100
anthropics/claude-plugins-official#6763 · コメント 10 件 · リアクション 10 件 ·
メンテナーはふだん 3 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信