Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Translator API/misc improvements

Aperta
  • Qualcosa non va?
#475 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Refactoring
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
api, documentation

Direzione di ricerca

Inizia esaminando il modulo translator, la sua classe padre astratta, le classi di implementazione e AlleleTranslator._create_allele, insieme ai singoli metodi from. Questa è un’ampia lista dei desideri, quindi conferma innanzitutto quale miglioramento della documentazione, dell’annotazione di tipo, di fmt, di kwargs o dell’ambito degli argomenti è previsto; per l’elemento selezionato deve essere definito cosa significhi done prima di iniziare il lavoro.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement VRS translator

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 fmt values in an enum
  • Document kwargs for 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 with help() or in docs if we ever make them.
  • Not clear to me why args in AlleleTranslator._create_allele are kwargs -- if it's for flexibility between individual _from_fmt methods, 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_fmt method, ...
Lingua principale
Python
Stelle
63
Fork
43
Merge medio
1h 2m
PR unite (30g)
1

Preparare l'ambiente

Non abbiamo ancora controllato i file di configurazione di questo progetto. Parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ga4gh/vrs-python

Tutte le issue di ga4gh/vrs-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.