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

Format function signatures for pkgdown #476

Closed
hfrick opened this issue May 16, 2024 · 3 comments
Closed

Format function signatures for pkgdown #476

hfrick opened this issue May 16, 2024 · 3 comments
Labels
documentation tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day

Comments

@hfrick
Copy link
Member

hfrick commented May 16, 2024

It'd be nice to not have to scroll horizontally in situations like this:

Screenshot 2024-05-16 at 10 37 49
@hfrick hfrick added documentation tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day labels May 16, 2024
@jplecavalier
Copy link

This behaviour is actually caused by roxygen2:::wrap_usage() default behaviour of wrapping the @usage bloc on multiple lines only when the width is greater than 80 characters. As one could see, this specific example is 79 characters wide and this explains why it is not wrapped automatically.

nchar("mc_cv(data, prop = 3/4, times = 25, strata = NULL, breaks = 4, pool = 0.1, ...)")
#>  [1] 79

A workaround to solve this specific problem would be to manually write the @usage bloc in the function header, but as discussed with @hfrick at tidy-dev-day, this is not a good idea.

@hfrick
Copy link
Member Author

hfrick commented Aug 15, 2024

Thank you for looking into this @jplecavalier ! I'll close this this is more complexity than is worth it here

@hfrick hfrick closed this as not planned Won't fix, can't repro, duplicate, stale Aug 15, 2024
Copy link

This issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex: https://reprex.tidyverse.org) and link to this issue.

@github-actions github-actions bot locked and limited conversation to collaborators Aug 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day
Projects
None yet
Development

No branches or pull requests

2 participants