RDoc needs a directive to not clobber an overridden method definition's documentation, but add to it.
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
- 45/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- ruby
- Ambito
- documentation
Direzione di ricerca
Inizia tracciando il modo in cui RDoc gestisce la documentazione dei metodi sovrascritti e come vengono rappresentate le direttive esistenti. Definisci il comportamento della direttiva usando l’esempio Kernel.require, quindi aggiungi una copertura che dimostri che la documentazione originale viene preservata e che la documentazione del metodo sovrascrivente viene aggiunta anziché sostituirla.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
RDoc needs a directive to not clobber an overridden method definition's documentation, but add to it.
Use case: I wanted to find out how require worked.
Unfortunately, in RDoc-generated documentation, all I could find is information on how by requiring rubygems the behavior of Kernel.require changed, but nothing about its original behavior.
If RDoc had a directive to add, don't replace documentation, and it was used on the rubygems' monkeypatch of Kernel.require, the original documentation wouldn't have gotten lost.
- Lingua principale
- Ruby
- Stelle
- 927
- Fork
- 467
- Merge medio
- 23h 47m
- 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
-
RDoc 8.0.0 gem omits `doc/rdoc/example.rb`, which is referenced by the packaged markup documentationForse già presa @OskarEichler l’ha presa 41 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
-
Regexp generated from unescaped input in #expand_classForse già presa @jaynetics l’ha presa oggi. Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 25/100
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
-
Wrong heading levels in generated HTML?Forse già presa @st0012 l’ha presa 6 giorni fa. Apertabug
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
Dependencies view: `getParent` loops forever on untitled documents, extension host runs out of memoryForse già presa Una pull request collegata a questa issue è aperta o già unita. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
I maintainer di solito rispondono entro 1 giorno
-
area/web interface
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
mastodon/mastodon#41000 · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
zerocracy/judges-action#2743 ·
I maintainer di solito rispondono entro 8 giorni
-
Python 3.15 supportForse già presa @amnesiaof l’ha presa oggi. ApertaL: python L: python:uv
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
dependabot/dependabot-core#16524 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
Add Nagoya Ruby Kaigi 05Apertacontent good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 66/100
rubyevents/rubyevents#2182 ·
I maintainer di solito rispondono entro 1 giorno