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

Line length #786

Merged
merged 4 commits into from
Sep 21, 2023
Merged

Line length #786

merged 4 commits into from
Sep 21, 2023

Conversation

olivroy
Copy link
Contributor

@olivroy olivroy commented Sep 20, 2023

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

@mtennekes mtennekes merged commit c78278f into r-tmap:master Sep 21, 2023
4 of 5 checks passed
@olivroy olivroy mentioned this pull request Sep 21, 2023
5 tasks
@olivroy olivroy deleted the line-length branch September 24, 2023 12:34
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

Successfully merging this pull request may close these issues.

2 participants