Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR looks fairly large.
However, it may help with documentation debugging later.
Styled according to: https://style.tidyverse.org/documentation.html
It will be easier to pinpoint things when using find in files and ctrl + f in general.
To improve readability, I use 2 spaces, when param descriptions take up more than 2 lines.
You don't have to bother following this style for future doc writing (I find it a bit more effective to write it and then do bulk review at the end.)
This aims to reduce maintenance burden of documentation. When I will have a better understanding of the tmap internals, I will be able to consolidate bits that are reused in tmap. Example of what I did in openxlsx2 after cleaning up docs. https://github.com/JanMarvin/openxlsx2/pull/769/files