Documenting `Data` classes
I maintainer di solito rispondono entro 1 giorno
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- ruby
- Ambito
- documentation
Direzione di ricerca
Iniziate riproducendo gli esempi documentati con rdoc, con e senza il parser Prism, per Data.define, Struct.new e la riapertura della classe generata. Tracciate il modo in cui queste definizioni vengono classificate e verificate che la classe e i suoi metodi siano documentati come una classe, mentre la documentazione obsoleta di Object non venga mantenuta.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
rdoc does not usefully document data classes defined the correct way:
# Documenting a class made with Data.define
MyDataClass = Data.define :a do
# Capitalize the value of +a+.
def cap
a.capitalize
end
end
This documents a constant on Object, Object::MyDataClass instead of documenting it as a class itself, and the method within the data class definition is not documented either. It does not matter whether the Prism parser is used.
When documented with reopening, there are two different issues
MyDataClass = Data.define :a # :nodoc:
# Documenting a class made with Data.define
class MyDataClass
# Capitalize the value of +a+.
def cap
a.capitalize
end
end
If defined without # :nodoc:, MyDataClass is still documented as a constant on Object; if defined with # :nodoc:, the documentation is removed, but the generated documentation pages for Object isn't removed.
I believe that Data.define and Struct.new should be treated as if they were written as class variants.
- Lingua principale
- Ruby
- Stelle
- 929
- Fork
- 469
- Merge medio
- 1g 2h
- PR unite (30g)
- 19
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 37 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
-
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 2 giorni fa. Apertabug
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
I maintainer di solito rispondono entro 1 giorno
Issue simili
-
Add Catalan (ca) translationAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
eurosky-social/eu-haul#32 ·
-
README configuration examples use the wrong module name and describe removed Bootstrap assetsApertagood first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
benbalter/add-to-org#17 ·
-
good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
benbalter/change_agent#11 ·
-
good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
benbalter/count-org-loc#20 ·
-
good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
benbalter/sitemap-parser#33 ·