Standardize Rd \seealso links and update DESCRIPTION#292
Merged
Conversation
Standardize documentation links across man/*.Rd: replaced old \code{\link{...}} entries with explicit \code{\link[=name]{name()}} forms in generator, vector, and utility function \seealso sections to improve cross-references and consistency. Also updated DESCRIPTION by removing the RoxygenNote entry and adding Config/roxygen2/version: 8.0.0 to pin the roxygen2 version.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the package documentation by converting function links in the \seealso sections of numerous .Rd files to the newer \code{\link[=...]{...()}} format, and fixes a link typo in man/cmean.Rd. It also modifies the DESCRIPTION file by removing RoxygenNote and specifying the roxygen2 version config. The reviewer points out that removing RoxygenNote from the DESCRIPTION file can cause it to be automatically re-added during documentation builds, creating a dirty git state, and suggests updating it to 8.0.0 instead of removing it.
| @@ -17,7 +17,6 @@ Description: | |||
| License: MIT + file LICENSE | |||
| Encoding: UTF-8 | |||
| Roxygen: list(markdown = TRUE) | |||
Contributor
There was a problem hiding this comment.
The RoxygenNote field in the DESCRIPTION file is automatically managed and updated by roxygen2 (or devtools::document()) when generating documentation. Manually removing this field will result in it being re-added automatically the next time the documentation is built, leading to an unexpected dirty git state. Instead of removing it, it should be updated to match the pinned version of roxygen2 (e.g., 8.0.0).
Roxygen: list(markdown = TRUE)
RoxygenNote: 8.0.0
Contributor
There was a problem hiding this comment.
Pull request overview
This PR standardizes intra-package cross-references in generated Rd documentation by rewriting \seealso{} links into explicit \link[=name]{name()} form, and adjusts package metadata to reflect/pin the roxygen2 version used to generate docs.
Changes:
- Updated
\seealso{}sections across manyman/*.Rdfiles to use explicit\code{\link[=topic]{topic()}}links for more consistent cross-referencing. - Corrected the dplyr help-topic link used in
man/cmean.Rd(dplyr:cummean). - Updated
DESCRIPTIONmetadata by removingRoxygenNoteand addingConfig/roxygen2/version: 8.0.0.
Reviewed changes
Copilot reviewed 25 out of 54 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| man/subset_walks.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/std_cum_sum_augment.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/std_cum_prod_augment.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/std_cum_min_augment.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/std_cum_mean_augment.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/std_cum_max_augment.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/skewness_vec.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/rw_range.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/running_quantile.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/random_wilcoxon_sr_walk.Rd | Standardize generator/discrete-distribution \seealso{} links to explicit \link[=] format. |
| man/random_wilcox_walk.Rd | Standardize generator/discrete-distribution \seealso{} links to explicit \link[=] format. |
| man/random_weibull_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_uniform_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_t_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_smirnov_walk.Rd | Standardize generator/discrete-distribution \seealso{} links to explicit \link[=] format. |
| man/random_poisson_walk.Rd | Standardize generator/discrete-distribution \seealso{} links to explicit \link[=] format. |
| man/random_normal_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_normal_drift_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_negbinomial_walk.Rd | Standardize generator/discrete-distribution \seealso{} links to explicit \link[=] format. |
| man/random_multinomial_walk.Rd | Standardize generator/discrete-distribution \seealso{} links to explicit \link[=] format. |
| man/random_lognormal_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_logistic_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_hypergeometric_walk.Rd | Standardize generator/discrete-distribution \seealso{} links to explicit \link[=] format. |
| man/random_geometric_walk.Rd | Standardize generator/discrete-distribution \seealso{} links to explicit \link[=] format. |
| man/random_gamma_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_f_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_exponential_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_displacement_walk.Rd | Standardize generator/discrete-distribution \seealso{} links to explicit \link[=] format. |
| man/random_chisquared_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_cauchy_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/random_binomial_walk.Rd | Standardize generator/discrete-distribution \seealso{} links to explicit \link[=] format. |
| man/random_beta_walk.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/rand_walk_helper.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/rand_walk_column_names.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/kurtosis_vec.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/get_attributes.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/geometric_brownian_motion.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| man/generate_caption.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/euclidean_distance.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/discrete_walk.Rd | Standardize generator/discrete-distribution \seealso{} links to explicit \link[=] format. |
| man/cvar.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/custom_walk.Rd | Standardize generator-function \seealso{} links to explicit \link[=] format. |
| man/cskewness.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/csd.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/crange.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/convert_snake_to_title_case.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/confidence_interval.Rd | Standardize \seealso{} utility-function links to explicit \link[=] format. |
| man/cmedian.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/cmean.Rd | Fix dplyr help-topic link and standardize \seealso{} vector-function links. |
| man/ckurtosis.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/chmean.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/cgmean.Rd | Standardize \seealso{} vector-function links to explicit \link[=] format. |
| man/brownian_motion.Rd | Standardize generator/continuous-distribution \seealso{} links to explicit \link[=] format. |
| DESCRIPTION | Update roxygen-related metadata (remove RoxygenNote, add Config/roxygen2/version). |
Files not reviewed (29)
- man/brownian_motion.Rd: Language not supported
- man/cgmean.Rd: Language not supported
- man/chmean.Rd: Language not supported
- man/ckurtosis.Rd: Language not supported
- man/cmean.Rd: Language not supported
- man/cmedian.Rd: Language not supported
- man/confidence_interval.Rd: Language not supported
- man/convert_snake_to_title_case.Rd: Language not supported
- man/crange.Rd: Language not supported
- man/csd.Rd: Language not supported
- man/cskewness.Rd: Language not supported
- man/custom_walk.Rd: Language not supported
- man/cvar.Rd: Language not supported
- man/discrete_walk.Rd: Language not supported
- man/euclidean_distance.Rd: Language not supported
- man/generate_caption.Rd: Language not supported
- man/geometric_brownian_motion.Rd: Language not supported
- man/get_attributes.Rd: Language not supported
- man/kurtosis_vec.Rd: Language not supported
- man/rand_walk_column_names.Rd: Language not supported
- man/rand_walk_helper.Rd: Language not supported
- man/random_beta_walk.Rd: Language not supported
- man/random_binomial_walk.Rd: Language not supported
- man/random_cauchy_walk.Rd: Language not supported
- man/random_chisquared_walk.Rd: Language not supported
- man/random_displacement_walk.Rd: Language not supported
- man/random_exponential_walk.Rd: Language not supported
- man/random_f_walk.Rd: Language not supported
- man/random_gamma_walk.Rd: Language not supported
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Standardize documentation links across man/*.Rd: replaced old \code{\link{...}} entries with explicit \code{\link[=name]{name()}} forms in generator, vector, and utility function \seealso sections to improve cross-references and consistency. Also updated DESCRIPTION by removing the RoxygenNote entry and adding Config/roxygen2/version: 8.0.0 to pin the roxygen2 version.