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

Aliki: Hard to discern method blocks visually

Aperta
  • Qualcosa non va?
#1,573 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
ruby
Ambito
design, documentation

Direzione di ricerca

Inizia riproducendo la documentazione dei metodi segnalata e la barra laterale destra nell'HTML generato da RDoc, usando gli screenshot come riferimento visivo. Traccia il modo in cui vengono renderizzati i nomi dei metodi e le voci Args e Description, quindi individua i template o gli stili pertinenti. Il lavoro è completato quando i confini tra i metodi sono visivamente chiari e le voci della barra laterale indicano a quale metodo appartengono.

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

Descrizione

I find it really hard to see where a method documentation starts and ends:

Image

The headers "Args" and "Description" are much bigger than the method name although they are subordinate to it. This means when scrolling through the page it is hard - at least for me - to discern the part that belongs to a method.

I'm not sure whether this is the same problem but the right side bar is also quite useless in this case:

Image

It is just a list of "Args" and "Description" entries without a hint for what.

Lingua principale
Ruby
Stelle
929
Fork
469
Merge medio
1g 2h
PR unite (30g)
19

Preparare l'ambiente

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 ruby/rdoc

Tutte le issue di ruby/rdoc

Issue simili

Altre issue su Ruby

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.