Closes #111 dataset contents ref pages #130
Conversation
|
@vbshuliar once you update |
|
@manciniedoardo @bundfussr Please take a look at the updated version. |
There was a problem hiding this comment.
Thanks @vbshuliar - I tested the actual process and looks great. I've added a couple of comments.
In addition to the above I also tried rendering the site. Looks good, but can you please restructure the reference page so that it mentions datasets and not functions:
Edit: get_terms() should still be under functions.
|
I updated the layout as you requested. Please, proceed with the rereview @manciniedoardo
|
|
There was a problem hiding this comment.
@vbshuliar , thanks for the updates.
Could you make the URLs in the HTML version clickable? For example, the yellow highlighted URL below is just text.
.lintr
Outdated
| "R" = Inf, | ||
| "inst" = list(undesirable_function_linter = Inf), | ||
| "vignettes" = list(undesirable_function_linter = Inf), | ||
| "data-raw" = list(undesirable_function_linter = Inf) | ||
| "data-raw" = Inf |
There was a problem hiding this comment.
I'm not sure if we should turn off lintr completely for all files in R and data-raw.
@manciniedoardo , what do you think?
There was a problem hiding this comment.
ideally not completely, is there a more granular approach?
There was a problem hiding this comment.
I would keep the old setting for data-raw where we just turn off the undesirable function lintr.
For the R folder I would not turn off anything. To avoid issues with the line length I would wrap the lines with stringr::str_wrap() and enclose lines which are too long after that with # nolint start: line_length_linter and # nolint end.
There was a problem hiding this comment.
@manciniedoardo @bundfussr What if I set the exclusion to only the line length parameter in the generated files, instead of ignoring everything? This approach would be more specific and still allow us to track important inconsistencies.
Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral codebase remains robust and consistent.
Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the
develbranch until you have checked off each task.styler::style_file()to style R and Rmd filesdevtools::document()so all.Rdfiles in themanfolder and theNAMESPACEfile in the project root are updated appropriatelyNEWS.mdif the changes pertain to a user-facing function (i.e. it has an@exporttag) or documentation aimed at users (rather than developers)pkgdown::build_site()and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.lintr::lint_package()R CMD checklocally and address all errors and warnings -devtools::check()