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.

Sign up for GitHub

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

Jump to bottom

Use more consistent representations in function documentation and hyperlink functions #511

Merged
merged 8 commits into from
Nov 22, 2023
Merged

Use more consistent representations in function documentation and hyperlink functions #511

merged 8 commits into from
Nov 22, 2023

Conversation

jamesmbaazam
Copy link
Contributor

@jamesmbaazam jamesmbaazam commented Nov 14, 2023 •
edited
Loading

This PR fixes #508 by hyperlinking all referenced functions in the function documentation across the code base. It also closes #510 by applying a consistent style and formatting to functions, arguments, R packages, objects, and classes.

@jamesmbaazam jamesmbaazam marked this pull request as draft November 14, 2023 15:51
@jamesmbaazam
Copy link
Contributor Author

jamesmbaazam commented Nov 15, 2023 •
edited
Loading

@seabbs Here,

EpiNow2/R/get.R

Lines 5 to 6 in 65e6c5a

#' @param results_dir A character string giving the directory in which results
#' are stored (as produced by `regional_rt_pipeline`).
, has the name regional_rt_pipeline changed? I can't seem to find it.

@jamesmbaazam jamesmbaazam reopened this Nov 15, 2023
@jamesmbaazam jamesmbaazam marked this pull request as ready for review November 16, 2023 16:24
@jamesmbaazam jamesmbaazam changed the title Improve styling of functions' documentation Use more consistent representations in function documentation and hyperlink functions Nov 16, 2023
@jamesmbaazam jamesmbaazam requested review from sbfnk and seabbs November 16, 2023 16:25
@jamesmbaazam jamesmbaazam self-assigned this Nov 16, 2023
@jamesmbaazam jamesmbaazam added the documentation Improvements or additions to documentation label Nov 16, 2023
@seabbs
Copy link
Contributor

seabbs commented Nov 16, 2023

Yup I think it's no regional_epinow (as discussed today)

seabbs
seabbs previously approved these changes Nov 16, 2023
View reviewed changes
Copy link
Contributor

@seabbs seabbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks James this looks great. Only comment is about if Stan should be wrapped in brackets as it's not an R package?

R/create.R Outdated Show resolved Hide resolved
@jamesmbaazam jamesmbaazam requested a review from seabbs November 20, 2023 20:33
@jamesmbaazam
Copy link
Contributor Author

jamesmbaazam commented Nov 21, 2023 •
edited
Loading

@seabbs I believe this should be ready for merge. Not sure if it's NEWS worthy.

sbfnk
sbfnk approved these changes Nov 22, 2023
View reviewed changes
Copy link
Contributor

@sbfnk sbfnk left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work.

@sbfnk sbfnk merged commit 689ee94 into main Nov 22, 2023
12 checks passed
@sbfnk sbfnk deleted the hyperlink-functions branch November 22, 2023 19:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sbfnk sbfnk sbfnk approved these changes

@seabbs seabbs Awaiting requested review from seabbs

Assignees

@jamesmbaazam jamesmbaazam

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Consistency in documentation style Hyperlink *_opts() functions for better signposting in help files
3 participants
@jamesmbaazam @seabbs @sbfnk