dgkf / dgkf/devutils

feat(roxygen): Add roxygen tag for typed parameters/returns

Aperta
#1 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
R
Stelle
1
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

I often find myself re-writting the same statements for typed parameters:

```r
#' @param x A `character` vector [blah blah blah]
```

Shoving type information into plain text is a bit messy and would benefit from having a more consistent shorthand. At least for now, just having something that might parse and produce something better formatted would be nice:

```r
#' @paramt x [`character`] blah blah blah
```

That produces

```tex
\arguments{
\item{x \code{character}}{
blah blah blah
}
}
```

Would help to give the type information a more dedicated space in the documentation and consistently format it.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Iniziate ispezionando il repository alla ricerca dei punti di ingresso per il parsing di roxygen o la generazione della documentazione, nonché dei test esistenti per i tag dei parametri. Confrontate la sintassi @paramt proposta con l’output di esempio, quindi definite e testate un comportamento che esegua il rendering del tipo di parametro separatamente dalla sua descrizione in modo coerente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
r
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.