bug: backticks stripped from parameter names
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 75/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- r
- Ambito
- documentation
Direzione di ricerca
Inizia leggendo il percorso di elaborazione di roxygen2 che trasforma i tag @param in voci \item e confrontalo con l’output \usage mostrato nel riproduttore. Usa l’esempio fornito di roc_proc_text() per verificare se gli apici inversi intorno a _x e _y vengono mantenuti nel file f.Rd generato; il lavoro è concluso quando sono preservati e R CMD check non segnala più che questi argomenti non sono documentati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
This is probably related to #1915. \usage keeps backticks, but \item loses them, which causes R CMD check to emit warning re: undocumented arguments.
library(roxygen2)
rd <- roc_proc_text(rd_roclet(), "
#' Non-syntactic argument names
#' @param `_x` first argument
#' @param `_y` second argument
f <- function(`_x`, `_y`) NULL
")
rd[["f.Rd"]]
# % Generated by roxygen2: do not edit by hand
# % Please edit documentation in ./<text>
# \name{f}
# \alias{f}
# \title{Non-syntactic argument names}
# \usage{
# f(`_x`, `_y`)
# }
# \arguments{
# \item{_x}{first argument}
#
# \item{_y}{second argument}
# }
# \description{
# Non-syntactic argument names
# }
- Lingua principale
- R
- Stelle
- 666
- Fork
- 239
- Merge medio
- 3h 25m
- PR unite (30g)
- 1
Preparare l'ambiente
Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Nessuna 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 r-lib/roxygen2
-
API timelineAperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 30/100
-
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
Tutte le issue di r-lib/roxygen2
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
HelenaLC/spatialdataR#295 ·
-
size-time-budget
Difficoltà 2/5 1-3 ore Idoneità per principianti 69/100
kapelner/EDI#66 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
Openscapes/blogscapes#61 ·
I maintainer di solito rispondono entro 1 giorno
-
bug posit-ai
Difficoltà 2/5 1-3 ore Idoneità per principianti 62/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
Bioconductor/BiocFileCache#76 · 1 commento ·