Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tibble fails to parse usage #2384

Closed
hadley opened this issue Feb 28, 2022 · 4 comments · Fixed by #2385
Closed

Tibble fails to parse usage #2384

hadley opened this issue Feb 28, 2022 · 4 comments · Fixed by #2385
Labels
bug an unexpected problem or unintended behavior

Comments

@hadley
Copy link
Member

hadley commented Feb 28, 2022

Because of

\method{as_tibble}{`NULL`}(x, ...)
@hadley hadley transferred this issue from r-lib/usethis Feb 28, 2022
@hadley hadley added the bug an unexpected problem or unintended behavior label May 31, 2022
@krlmlr
Copy link
Member

krlmlr commented Jun 30, 2022

Reprex:

pkgdown::init_site("~/git/R/tibble")
#> Warning: Failed to parse usage:
#> 
#> as_tibble(
#>   x,
#>   ...,
#>   .rows = NULL,
#>   .name_repair = c("check_unique", "unique", "universal", "minimal"),
#>   rownames = pkgconfig::get_config("tibble::rownames", NULL)
#> )
#> 
#> S3method(`as_tibble`, `data.frame`)(
#>   x,
#>   validate = NULL,
#>   ...,
#>   .rows = NULL,
#>   .name_repair = c("check_unique", "unique", "universal", "minimal"),
#>   rownames = pkgconfig::get_config("tibble::rownames", NULL)
#> )
#> 
#> S3method(`as_tibble`, `list`)(
#>   x,
#>   validate = NULL,
#>   ...,
#>   .rows = NULL,
#>   .name_repair = c("check_unique", "unique", "universal", "minimal")
#> )
#> 
#> S3method(`as_tibble`, `matrix`)(x, ..., validate = NULL, .name_repair = NULL)
#> 
#> S3method(`as_tibble`, `table`)(x, `_n` = "n", ..., n = `_n`, .name_repair = "check_unique")
#> 
#> S3method(`as_tibble`, ``NULL``)(x, ...)
#> 
#> S3method(`as_tibble`, `default`)(x, ...)
#> 
#> as_tibble_row(
#>   x,
#>   .name_repair = c("check_unique", "unique", "universal", "minimal")
#> )
#> 
#> as_tibble_col(x, column_name = "value")
#> -- Initialising site -----------------------------------------------------------
#> Copying '../../../Library/R/arm64/4.1/library/pkgdown/BS5/assets/link.svg' to 'link.svg'
#> Copying '../../../Library/R/arm64/4.1/library/pkgdown/BS5/assets/pkgdown.js' to 'pkgdown.js'
#> Copying 'pkgdown/favicon/apple-touch-icon-120x120.png' to 'apple-touch-icon-120x120.png'
#> Copying 'pkgdown/favicon/apple-touch-icon-152x152.png' to 'apple-touch-icon-152x152.png'
#> Copying 'pkgdown/favicon/apple-touch-icon-180x180.png' to 'apple-touch-icon-180x180.png'
#> Copying 'pkgdown/favicon/apple-touch-icon-60x60.png' to 'apple-touch-icon-60x60.png'
#> Copying 'pkgdown/favicon/apple-touch-icon-76x76.png' to 'apple-touch-icon-76x76.png'
#> Copying 'pkgdown/favicon/apple-touch-icon.png' to 'apple-touch-icon.png'
#> Copying 'pkgdown/favicon/favicon-16x16.png' to 'favicon-16x16.png'
#> Copying 'pkgdown/favicon/favicon-32x32.png' to 'favicon-32x32.png'
#> Copying 'pkgdown/favicon/favicon.ico' to 'favicon.ico'
#> Copying 'man/figures/logo.svg' to 'logo.svg'

Created on 2022-06-30 by the reprex package (v2.0.1)

@krlmlr
Copy link
Member

krlmlr commented Sep 3, 2022

Does this belong in roxygen2 instead? I worked around in tibble: tidyverse/tibble#1369.

@hadley
Copy link
Member Author

hadley commented Dec 11, 2023

Yeah, I think you're right.

@hadley hadley transferred this issue from r-lib/pkgdown Dec 11, 2023
hadley referenced this issue in r-lib/roxygen2 Dec 11, 2023
@hadley
Copy link
Member Author

hadley commented Dec 11, 2023

Nope, changed my mind. R cmd check likes this:

\method{odbcPreviewQuery}{`Microsoft SQL Server`}(connection, rowLimit, name)

and doesn't like this:

\method{odbcPreviewQuery}{Microsoft SQL Server}(connection, rowLimit, name)

So the parsing problem is in pkgdown.

@hadley hadley transferred this issue from r-lib/roxygen2 Dec 11, 2023
hadley added a commit that referenced this issue Dec 12, 2023
`\method{}`, unlike `\S4method{}`, requires non-syntactic names to be escaped with backticks, so we don't need to escape again.

Fixes #2384
hadley added a commit that referenced this issue Jan 3, 2024
`\method{}`, unlike `\S4method{}`, requires non-syntactic names to be escaped with backticks, so we don't need to escape again.

Fixes #2384
SebKrantz pushed a commit to SebKrantz/pkgdown that referenced this issue Jun 1, 2024
`\method{}`, unlike `\S4method{}`, requires non-syntactic names to be escaped with backticks, so we don't need to escape again.

Fixes r-lib#2384
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug an unexpected problem or unintended behavior
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants