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

Add @method roxygen statements to "early" knit_print methods #826

Closed
Puzzled-Face opened this issue Jun 5, 2024 · 0 comments · Fixed by #827
Closed

Add @method roxygen statements to "early" knit_print methods #826

Puzzled-Face opened this issue Jun 5, 2024 · 0 comments · Fixed by #827
Assignees
Labels
Milestone

Comments

@Puzzled-Face
Copy link
Collaborator

Puzzled-Face commented Jun 5, 2024

Whilst I developed the knit_print methods, I realised that the way I had initially documented the methods was sub-optimal. The recommended ay to implement an S3 method for an S4 class is

#' @method <method name> <class name>

Method documentation in helpers_knitr_Increments.R, helpers_knitr_CohortSize.R and helpers_knitr_GeneralData.R should be updated.

This is a sub task of #774.

[Famous last words] This should be straightforward.

@Puzzled-Face Puzzled-Face self-assigned this Jun 5, 2024
@Puzzled-Face Puzzled-Face added this to the CRAN milestone Jun 5, 2024
@Puzzled-Face Puzzled-Face linked a pull request Jun 5, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant