You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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().
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
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
The text was updated successfully, but these errors were encountered:
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.
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()
.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
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
The text was updated successfully, but these errors were encountered: