Broken function documentation when using newer rubies and function contains any code before documentation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 45/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- ruby
- Ambito
- documentation, tooling
Direzione di ricerca
Inizia da lib/puppet/functions/to_yaml.rb e lib/puppet/functions/to_json.rb, quindi riproduci la generazione del riferimento con Ruby 2.5 e 2.7 usando Puppet Strings 2.9.0. Traccia il modo in cui vengono estratti i commenti della documentazione quando le istruzioni require li precedono; il lavoro è completato quando entrambe le funzioni producono documentazione in modo coerente nelle versioni di Ruby segnalate.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
I've noticed that when generating reference documentation for stdlib, the version of ruby used changes the output.
Specifically, the documentation for to_yaml and to_json doesn't get generated with Ruby 2.7 but does when using Ruby 2.5. (Puppet Strings 2.9.0 in both cases)
No other functions in stdlib are affected. There appears to be an issue with having any code before the documentation comments. In these functions, this is a require 'yaml' and require 'json' respectively. I could easily workaround the issue by moving this code into the function dispatches, but the change of behaviour between Ruby versions makes me think it's worth raising this as a bug here.
- Lingua principale
- Ruby
- Stelle
- 90
- Fork
- 92
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un 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 puppetlabs/puppet-strings
-
bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
puppetlabs/puppet-strings#389 · 3 commenti · 1 reazione ·
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 55/100
puppetlabs/puppet-strings#386 ·
-
maintenance
Difficoltà 2/5 1-3 ore Idoneità per principianti 35/100
puppetlabs/puppet-strings#370 ·
-
bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
puppetlabs/puppet-strings#365 ·
-
community feature
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
puppetlabs/puppet-strings#353 ·
Tutte le issue di puppetlabs/puppet-strings
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
Dialog: clicking the panel's inner padding closes it (backdropClick matches the <dialog> itself)Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
Homebrew/homebrew-cask#295450 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 Mezza giornata Idoneità per principianti 72/100
TheOdinProject/curriculum#31479 ·
I maintainer di solito rispondono entro 1 giorno
-
建议移除 dogfight360.com：当前解析到境外Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100