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

IO inaccuracies in documentation

Aperta
  • Qualcosa non va?
#34 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Individua la documentazione relativa alle colonne di input, agli output risolti e all’opzione --full-rerun, quindi verifica ogni affermazione rispetto al comportamento attuale del comando. Aggiorna la documentazione per descrivere scientific_name come nullable-but-required, source_id, gli output condizionali .resolved/.unsolved e .forced; annota il comportamento effettivo del manifest common-names mentre viene risolta la decisione separata sulla funzionalità.

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

Descrizione

documentation
  • scientific_name is a required input field. It may be null, but the column must be present for validation. Current docs describe it as optional, which is misleading as-is.
  • input columns should mention source_id
  • output files documentation implies a .resolved and .unsolved file will always be written for every resolve command input. But resolve might not include .unsolved if everything that is written goes into .resolved (misleading as-is). Also forgot to mention .forced.
  • --full-rerun doesn't affect common names manifest. This functionality (or lack thereof) should be clarified, and separately decided on whether or not it should exist in some form.
Lingua principale
Python
Stelle
19
Fork
0
Nessuna PR unita negli ultimi 30g

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 Imageomics/TaxonoPy

Tutte le issue di Imageomics/TaxonoPy

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.