riseproject-dev / riseproject-dev/python-wheels

docs: clean up field usage

Aperta
#386 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation enhancement good first issue infrastructure
Lingua principale
Python
Stelle
0
Fork
0
Merge medio
16h 14m
PR unite (30g)
952

Descrizione

We currently have a mixture of several fields in our package docs. Between historic patterns and new workflows, each package may feature one or more of:

  1. comment - a generic field for providing commentary on a package. This was previously always used to provide a link to a GPL sources tarball if required for a package
  2. warning - usually used to indicate we've had to skip some sort of test or omit a piece of functionality in a module, due to incompatibility or known issues with riscv64 or our infrastructure
  3. patched - a typically blank field used to signal that the package is built with one or more patches applied during the process

These are all somewhat redundant. I propose two to replace these:

  1. gpl-sources - specify this with one or more links if we have to provide GPL source tarballs as part of the package builds
  2. comment - anything else (notes about patching, skipping tests, etc.) goes here

@justeph @luhenry thoughts?

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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.

Direzione di ricerca

La issue non indica file o test specifici; individua innanzitutto i campi della documentazione dei package che attualmente usano comment, warning e patched. Conferma lo schema dei campi proposto prima di migrare le voci: usa gpl-sources per i link al codice sorgente GPL e comment per le altre note; quindi verifica che non rimanga alcun uso dei vecchi campi.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.