Poniższy MWE nie skompilować (przez devtools::document()
):Korzystanie niesymetrycznego klamra w kodzie np Roxygen/Rd
#' MWE
#'
#' @examples
#' format('{}') # Works
#' format('{') # Nope
#' format('\{') # Nope
#' format('\\{')# Nope
format = function (str) {}
Niezależnie od tego, który z „nope” linie I obejmują, to zawsze kończy się niepowodzeniem z błędem
Niepowodzenie w bloku roxygen zaczynają mwe.r: 1
niedopasowane szelki ...
Accordi ng do mojego czytania Rd documentation, powinno to działać przez ucieczkę z nawiasu klamrowego. Jednakże, jak pokazano powyżej, nie działa to jako . Czy robię coś złego, czy jest to błąd w Roxygen?
Jedna wskazówka, że może to być błąd Roxygen jest pełny komunikat o błędzie podczas korzystania z pojedynczą zmianą wersji (format('\{')
):
Niezgodne szelki:
"@example format('{}') # Works format('\\{') # Nope"
pamiętać, że pojedynczy ukośnik odwrotny na wejściu został podwojony na wyjściu.
@Josh swojego (już usunięte) odpowiedź sprawia, że ten kompilacji, ale - jak można zauważyć, rozważa usunięcie - skutkuje złamanym pliku Rd że pokaże błędy podczas próby wyświetlenia pomocy w R. Czy możemy więc stwierdzić, że jest to błąd roxygen? –
To na pewno wygląda jak błąd. Usunąłem, ponieważ zdałem sobie sprawę (duh), że dodatkowy klamr został właśnie użyty do zamknięcia sekcji '\ examples {}' –
Cóż, błąd zgłoszony na https://github.com/klutometis/roxygen/issues/393 –