Skip to content

Resolve or silence documentation warnings for epi_archive #74

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

Closed
brookslogan opened this issue May 11, 2022 · 2 comments
Closed

Resolve or silence documentation warnings for epi_archive #74

brookslogan opened this issue May 11, 2022 · 2 comments
Labels
cleanup improvements to developing&building experience&quality, not directly to built pkg&docs documentation Improvements or additions to documentation duplicate This issue or pull request already exists P2 low priority

Comments

@brookslogan
Copy link
Contributor

brookslogan commented May 11, 2022

Attempting to devtools::document() the package results in several warnings regarding the docstrings for epi_archive:

Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:80] undocumented R6 method: `print`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:80] undocumented R6 fields: `DT`, `geo_type`, `time_type`, `additional_metadata`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:191] argument `max_version` undocumented for R6 method `as_of()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:191] argument `min_time_value` undocumented for R6 method `as_of()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:235] argument `y` undocumented for R6 method `merge()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:235] argument `...` undocumented for R6 method `merge()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:235] argument `locf` undocumented for R6 method `merge()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:235] argument `nan` undocumented for R6 method `merge()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:266] argument `f` undocumented for R6 method `slide()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:266] argument `...` undocumented for R6 method `slide()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:266] argument `n` undocumented for R6 method `slide()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:266] argument `group_by` undocumented for R6 method `slide()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:266] argument `ref_time_values` undocumented for R6 method `slide()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:266] argument `time_step` undocumented for R6 method `slide()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:266] argument `new_col_name` undocumented for R6 method `slide()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:266] argument `as_list_col` undocumented for R6 method `slide()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:266] argument `names_sep` undocumented for R6 method `slide()`
Warning: [/home/fullname/files/tooling/epiprocess/R/archive.R:266] argument `all_rows` undocumented for R6 method `slide()`
Writing NAMESPACE

Investigate:

  • which are intentional due to the complications of documenting dual R6-S3 classes, and should be silenced if possible (so we can easily notice real documentation warnings for other things)
  • which require just a little copying/shifting around of content or placing appropriate roxygen tags
  • which require describing actually-undocumented functions/parameters (probably the most work)

and implement the appropriate changes.

@brookslogan brookslogan added the documentation Improvements or additions to documentation label May 11, 2022
@dajmcdon dajmcdon self-assigned this May 11, 2022
@dajmcdon
Copy link
Contributor

dajmcdon commented May 11, 2022

I have a fix for most of this on my fork.

I lied. I haven't fixed these but R-CMD-Check doesn't care.

@dajmcdon dajmcdon removed their assignment May 11, 2022
@brookslogan brookslogan added P2 low priority cleanup improvements to developing&building experience&quality, not directly to built pkg&docs labels May 24, 2022
@brookslogan brookslogan added the duplicate This issue or pull request already exists label Aug 1, 2022
@brookslogan
Copy link
Contributor Author

Closing this as a duplicate of #132, as there are more specific suggestions about how to resolve this there.

@brookslogan brookslogan closed this as not planned Won't fix, can't repro, duplicate, stale Aug 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup improvements to developing&building experience&quality, not directly to built pkg&docs documentation Improvements or additions to documentation duplicate This issue or pull request already exists P2 low priority
Projects
None yet
Development

No branches or pull requests

2 participants