bug: backticks stripped from parameter names

Aperta Adatta ai principianti
#1,932 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

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

Apri in Codespaces

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

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di r-lib/roxygen2

Tutte le issue di r-lib/roxygen2

Issue simili

Altre issue su R

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.