Don't include method documentation for aliased methods
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 42/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- ruby
- Ambito
- documentation
Direzione di ricerca
Inizia con la sezione della guida alla documentazione collegata nell’issue, quindi riproduci la documentazione generata di Array#find e Array#detect per comprendere il comportamento dell’alias. Esamina come RDoc gestisce gli aliased methods e determina come dovrebbe funzionare una modalità opzionale di soppressione. Il lavoro è completato quando gli alias non producono più documentazione duplicata fuorviante, mentre il metodo originale continua a essere documentato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
In Ruby, the documentation guide states:
Omit aliases from the
call-seq, unless the alias is an operator method.
This is intended prevent documentation duplication and have the reader read the documentation for the original method. However, this leads to all of the aliases to not have call-seq so the method appears to accept no arguments and is misleading to the reader (e.g. Array#find and the alias Array#detect appears to take no arguments).
I think RDoc should (at least have the option to) avoid generating documentation for aliased methods.
(This discussion originated from https://github.com/ruby/ruby/pull/15756)
- Lingua principale
- Ruby
- Stelle
- 930
- Fork
- 472
- Merge medio
- 2g 8h
- PR unite (30g)
- 12
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di ruby/rdoc
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationForse già presa @OskarEichler l’ha presa 80 giorni fa. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
I maintainer di solito rispondono entro 1 giorno
-
markdown html excerpt includes link partsForse già presa @anyingiit l’ha presa 26 giorni fa. Aperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 66/100
I maintainer di solito rispondono entro 1 giorno
-
Regexp generated from unescaped input in #expand_classForse già presa @jaynetics l’ha presa 39 giorni fa. Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 25/100
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
bug f:request-creation professional
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
mysociety/alaveteli#9733 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
needs verification
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
I maintainer di solito rispondono entro 13 giorni
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
betagouv/conseillers-entreprises#4808 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100