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

\usage() length #1624

Closed
olivroy opened this issue May 29, 2024 · 1 comment
Closed

\usage() length #1624

olivroy opened this issue May 29, 2024 · 1 comment

Comments

@olivroy
Copy link
Contributor

olivroy commented May 29, 2024

Related to #1617, but different.

For functions with many arguments, roxygen2 places all the arguments on different lines.

However, since R 4.2, there is html support in help files, which means you can scroll horizontally to see arguments if needed.

My point is that you have to scroll down a lot to see documentation of arguments.

See example for tmap::tm_text().
image

When functions are documented together, this makes it even worse in my opinion.

I am also not convinced spaces between documented functions together are necessary, especially when there are more than 4-5 functions documented together.

See ?gert::git_commit

In help, it just reduces the amount of information you can see in a single screen

image

It would be good to have usage store 2-3 arguments on the same line whenever possible + reudce space when many functions are documented together

@hadley
Copy link
Member

hadley commented Jul 9, 2024

Unfortunately I don't think you'll be able to persuade me that this is a good idea 😄 IMO the problem here is documenting too many functions in the same file.

@hadley hadley closed this as completed Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants