Skip to content

Fix malformed skewness/kurtosis formulas in vector function docs#291

Merged
spsanderson merged 2 commits into
mainfrom
copilot/fix-malformed-kurtosis-skewness-formulas
May 27, 2026
Merged

Fix malformed skewness/kurtosis formulas in vector function docs#291
spsanderson merged 2 commits into
mainfrom
copilot/fix-malformed-kurtosis-skewness-formulas

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 27, 2026

The documentation for kurtosis_vec() and skewness_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

    • Replaced malformed inline formula strings in R/vec-cumulative-functions.R with valid display-math \deqn{} expressions for both functions.
  • Generated Rd sync

    • Updated man/kurtosis_vec.Rd and man/skewness_vec.Rd to match the corrected roxygen math output.
  • Formula shape now documented as

    #' \deqn{\frac{\frac{1}{n} \sum (x - \mu)^4}{\left(\frac{1}{n} \sum (x - \mu)^2\right)^2}}
    #' \deqn{\frac{\frac{1}{n} \sum (x - \mu)^3}{\left(\frac{1}{n} \sum (x - \mu)^2\right)^{3/2}}}

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
Copilot AI requested a review from spsanderson May 27, 2026 02:33
@spsanderson spsanderson marked this pull request as ready for review May 27, 2026 02:42
Copilot AI review requested due to automatic review settings May 27, 2026 02:42
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 .Rd files to keep man/ 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 spsanderson self-requested a review May 27, 2026 02:46
@spsanderson spsanderson merged commit 8c0cd6d into main May 27, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix malformed skewness and kurtosis formulas in roxygen documentation

3 participants