Remove examples for non-exported functions #181
Assignees
Labels
Comments
|
reverted changes to pre-release branch #187 |
averissimo
added a commit
that referenced
this issue
Feb 14, 2024
# Pull Request <!--- Replace `#nnn` with your issue link for reference. --> Fixes #172 ### Summary * Review and update: * [x] README.md (check example code) * [x] NEWS.md * one liner change * Review functions: * [x] @example tag, make sure it runs, fix if otherwise * [x] Make sure functions has @return tag to document the return value * [x] no \dontrun tag, replace with if(interactive()) if needed * `merge_datasets` example is insufficient * [x] Package `Title` is not duplicated in Package `Description` in DESCRIPTION file (e.g. this happens in teal.slice currently) * [x] You have checked the Package Release Template https://github.com/insightsengineering/teal.reporter/pull/205/files * [x] Make sure there are no `:::` in examples * if you need to retain the example that uses `:::`, use `getFromNamespace()` function. * [x] remove package:: call and depend package:: call from example. @kartikeyakirar * [x] Make sure all `teal.*` mentions are lower-cased and quoted * [x] Make sure each link to our documentation hosted with pkgdown on github pages do not have `/main/` in the address * it should have has `/latest-tag/` instead * so we always expose the documentation of the latest release and not what's currently on main branch but not yet released * [x] Remove old rd syntax * [x] Switch from title case into sentence case for title and description of functions. * [x] All package names in `Title` and `Description` fields of DESCRIPTION file are quoted with `'` _(not backtick)_ * [x] Sanity check of all vignettes, make sure there is no typo, no wrong format, etc. @kartikeyakirar #### New * [x] Remove prefixes from data calls `rADRS`, `rADTTE`, etc... (just like `{teal.data}`) * [x] Remove `return` wrapper if it is the last expression (per NEST guidelines) * #177 * [x] Remove exception in `.lintr`: `indentation_linter = NULL` * [x] ~Test for unused functions (in package and overall in NEST)~ @averissimo * PR request against this feature branch * 🛑 This should not be done on this release as it may have unintended consequences. * [See this comment](#176 (comment)) with possible candidates * [x] Standard order of roxygen2 tags * `@title ➡️ @doctype ➡️ @description ➡️ @details ➡️ @Rdname ➡️ ` * `➡️ @inheritParams ➡️ @params ➡️ @return ➡️ @Seealso ➡️ @references ➡️` * `➡️ @examples ➡️ @export ➡️ @Keywords ➡️ @noRd` * [x] Remove `@noMd` (in favor of `Roxygen: list(markdown = TRUE)` in `DESCRIPTION`) #### To consider? * [x] Convert "# nolint" to specific rule exception * #178 * [x] ~Added `resolve()` to the list of exported functions as the sub-functions are exported (`resolve.delayed_variable_choices`, ...).~ * Let's discuss if this needs to be reverted. * Edit: this is a trick to have S3methods internally as `resolve` should not be exported see aff0f35 #### Move to its own issue * [x] Make sure non-exported functions do not have examples * #181 #### After checklist is completed _(🚨 blocked until checklist is completed)_ * [x] Run urlchecker::url_check() to identify broken links and fix * [x] Run R CMD check --as-cran make sure everything pass * [x] Make Sure `inst/WORDLIST` is minimalized #### Content review _(🚨 blocked for now)_ All tasks above are mostly focused on structure, standards and cleanup. Here is to look at content What to look for: * Review content of titles, descriptions, params, etc. * They should be clear to the reader * Review vignettes * Review content * All chunks of code are runnable Content-related tasks should have a PR against this feature branch. --------- Signed-off-by: André Veríssimo <211358+averissimo@users.noreply.github.com> Signed-off-by: Marcin <133694481+m7pr@users.noreply.github.com> Signed-off-by: kartikeya kirar <kirar.kartikeya1@gmail.com> Co-authored-by: 27856297+dependabot-preview[bot]@users.noreply.github.com <27856297+dependabot-preview[bot]@users.noreply.github.com> Co-authored-by: unknown <kirar.kartikeya1@gmail.com> Co-authored-by: m7pr <marcin.kosinski.mk1@roche.com> Co-authored-by: Marcin <133694481+m7pr@users.noreply.github.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
kartikeyakirar
added a commit
that referenced
this issue
Feb 15, 2024
fixes: #181 Note: - `resolve` methods are exported but generic is internal so here example of resolve is removed (resolve is used internally) - Earlier this was done to pre-release which has been reverted
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Examples for non-exported functions should be removed after #176 and before the initial CRAN release. We can restor the examples afterwards.
The Examples in question can be easily identified as they all contain
getFromNamespacecalls.Remove them all in one commit (can be a squash commit of a PR) so that it can be easily reverted.
The text was updated successfully, but these errors were encountered: