Fix malformed skewness/kurtosis formulas in vector function docs#291
Merged
spsanderson merged 2 commits intoMay 27, 2026
Merged
Conversation
Copilot
AI
changed the title
[WIP] Fix malformed skewness and kurtosis formulas in documentation
Fix malformed skewness/kurtosis formulas in vector function docs
May 27, 2026
spsanderson
approved these changes
May 27, 2026
spsanderson
approved these changes
May 27, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes malformed math expressions in the documentation for kurtosis_vec() and skewness_vec() so the formulas render correctly in the generated R help pages, improving the usability of these vector-statistics utilities within the RandomWalker package.
Changes:
- Replaced broken inline/backticked formula strings with valid LaTeX display-math using
\deqn{}in the roxygen docs. - Regenerated and committed the corresponding
.Rdfiles to keepman/output synchronized with roxygen source.
Reviewed changes
Copilot reviewed 1 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| R/vec-cumulative-functions.R | Updates roxygen documentation to use valid \deqn{} LaTeX formulas for kurtosis and skewness. |
| man/kurtosis_vec.Rd | Syncs generated Rd output to the corrected kurtosis \deqn{} formula. |
| man/skewness_vec.Rd | Syncs generated Rd output to the corrected skewness \deqn{} formula. |
Files not reviewed (2)
- man/kurtosis_vec.Rd: Language not supported
- man/skewness_vec.Rd: Language not supported
spsanderson
approved these changes
May 27, 2026
spsanderson
approved these changes
May 27, 2026
spsanderson
approved these changes
May 27, 2026
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.
The documentation for
kurtosis_vec()andskewness_vec()contained malformed math expressions (broken braces/parentheses and invalid symbols), which prevented correct rendering. This updates both formulas to valid LaTeX so the generated help output displays correctly.Roxygen source updates
R/vec-cumulative-functions.Rwith valid display-math\deqn{}expressions for both functions.Generated Rd sync
man/kurtosis_vec.Rdandman/skewness_vec.Rdto match the corrected roxygen math output.Formula shape now documented as