Skip to content

Correct malformed Rd documentation markup - #97

Merged
iagomosqueira merged 3 commits into
masterfrom
copilot/fix-warnings-checking-rd-files
Nov 9, 2026
Merged

iagomosqueira merged 3 commits into
masterfrom
copilot/fix-warnings-checking-rd-files

Conversation

Copilot AI commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

Several Rd pages contained malformed markup: dataset entries used \itemize instead of \describe, Extract operators had empty labels, a metrics link was missing its backslash, and rlnormar1 formulas contained unescaped braces.

  • Datasets and Extract: Use \describe for dataset entries; add Extract operator labels and escape $.
  • Metrics and rlnormar1: Correct the FLStock link and wrap formulas in \eqn{}.

Copilot AI linked an issue Nov 9, 2026 that may be closed by this pull request
5 tasks
Co-authored-by: iagomosqueira <1029847+iagomosqueira@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix warnings in Rd files as per issue description Correct malformed Rd documentation markup Nov 9, 2026
Copilot AI requested a review from iagomosqueira November 9, 2026 15:16
@iagomosqueira
iagomosqueira marked this pull request as ready for review November 9, 2026 15:17
Make the roxygen comments the source of the Rd fixes rather than
editing man/*.Rd by hand:
- FLArray.R: label Extract generic-function items and wrap signatures in \code{}
  so they are not auto-linked to non-existent topics.
- Regenerate Rd from roxygen (rlnormar1 now uses \eqn{} for formulas).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

@iagomosqueira iagomosqueira left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Accepted

@iagomosqueira
iagomosqueira merged commit 92ef331 into master Nov 9, 2026
1 check passed
@iagomosqueira
iagomosqueira deleted the copilot/fix-warnings-checking-rd-files branch November 9, 2026 15:28
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.

1. WARNING: checking Rd files

2 participants