ruby / ruby/delegate

SimpleDelegator documentation missing in ruby-docs.org

Aperta
#5 3 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Ruby
Stelle
25
Fork
14
Merge medio
8h 41m
PR unite (30g)
1

Descrizione

Since 3.0.0, the library documentation is only partially rendered. Neither SimpleDelegator nor
the DelegateClass kernel method appear in the documentation.

https://ruby-doc.org/stdlib-3.0.0/libdoc/delegate/rdoc/Delegator.html
https://ruby-doc.org/stdlib-3.0.1/libdoc/delegate/rdoc/Delegator.html
https://ruby-doc.org/stdlib-3.0.2/libdoc/delegate/rdoc/Delegator.html

I'm not sure if splitting it into one file per top-level definition would solve it, but it might be the case that ruby-docs does not support several top-level definitions in the same file?

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

Inizia confrontando le pagine collegate di ruby-docs.org per delegate 3.0.0 fino a 3.0.2, quindi esamina come vengono rappresentate le definizioni di primo livello della libreria delegate. Il lavoro è completo quando SimpleDelegator e il metodo DelegateClass di Kernel compaiono nella documentazione generata.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.