gbdev/pandocs

Inconsistent formatting of register section titles

Open

#163 aperta il 19 feb 2021

Vedi su GitHub
 (10 commenti) (0 reazioni) (0 assegnatari)Markdown (134 fork)auto 404
awaiting feedbackconsistency - stylecontentgood first issue

Metriche repository

Star
 (775 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

  • Settle on an overall format
  • Decide how to format "R/W"
  • Decide on how to format compat info

Original OP below.

#124 changed the register anchor format from ADDR - NAME - Descr (R/W) to ADDR - NAME (Descr) (R/W), but the old style is still present elsewhere (e.g. IF still uses it).

Which format do we want to settle on (not necessarily either of these)?

Guida contributor

Direzione di ricerca
Esamina i titoli delle sezioni dei registri attuali nel repository, identifica tutte le istanze del formato vecchio e nuovo e proponi un formato coerente per tutte le sezioni.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75