puppet-strings insists on redundant return value for puppet functions
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
Direzione di ricerca
Inizia riproducendo la generazione della documentazione per l’esempio stdlib::ensure e traccia la convalida che richiede un tag @return. Conferma come viene analizzato il tipo restituito dichiarato di Puppet, quindi aggiungi una copertura che mostri che una funzione tipizzata non necessita di un tag ridondante; il lavoro è completato quando la generazione riesce senza @return e i test esistenti continuano a passare.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Describe the Bug
When generating the documentation of a Puppet function, puppet-strings wants to see a @return tag in the comments, while the code already include the returned type.
Expected Behavior
puppet-strings should not want a @return tag.
Steps to Reproduce
Generate the documentation of a function (example taken from stdlib):
# @summary function to cast ensure parameter to resource specific value
function stdlib::ensure(
Variant[Boolean, Enum['present', 'absent']] $ensure,
Enum['directory', 'link', 'mounted', 'service', 'file', 'package'] $resource,
) >> String {
# [...]
}
Note the >> String that tells what the function returns.
Environment
- Version : 2.9.0
- Platform : Any
Additional Context
Suggested by @ekohl in https://github.com/puppetlabs/puppetlabs-stdlib/pull/1239#discussion_r861254739
- Lingua principale
- Ruby
- Stelle
- 90
- Fork
- 92
- Merge medio
- 13h 23m
- PR unite (30g)
- 2
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 82/100
I maintainer di solito rispondono entro 10 giorni
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
I maintainer di solito rispondono entro 2 giorni
-
area: devops area: integration help wanted lane: free-agent roadmap size: S type: fixture
Difficoltà 2/5 1-3 ore Idoneità per principianti 87/100
arminazimi/evergreen#1505 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
waiting-intake
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100