Skip to content

docs: fix \code{} tag in melt.Rd, add factor to nafill.Rd @param x#7778

Open
LeonidasZhak wants to merge 2 commits into
Rdatatable:masterfrom
LeonidasZhak:docs/fix-melt-nafill-rd
Open

docs: fix \code{} tag in melt.Rd, add factor to nafill.Rd @param x#7778
LeonidasZhak wants to merge 2 commits into
Rdatatable:masterfrom
LeonidasZhak:docs/fix-melt-nafill-rd

Conversation

@LeonidasZhak
Copy link
Copy Markdown

Two small documentation fixes:

1. melt.data.table.Rd line 59 — broken \code{} tag

The type coercion hierarchy was rendered with inconsistent formatting:

\code{list} > \code{character} > \code{numeric > integer > logical}

The \code{} tag spanned across two lines, putting the > signs between numeric/integer/logical inside monospace code while leaving list/character comparisons as plain text. Fixed to wrap each type individually:

\code{list} > \code{character} > \code{numeric} > \code{integer} > \code{logical}

2. nafill.Rd line 17 — @param x missing factor

The @param x description listed supported types as "logical, numeric or character" but the Details section (line 24) and examples (lines 40-43) confirm factor is also supported. Updated to match.

Validation

  • tools::checkRd('man/melt.data.table.Rd') — passes
  • tools::checkRd('man/nafill.Rd') — passes
  • nafill with factor input verified working

Files changed

File Change
man/melt.data.table.Rd Fix \code{} tag spanning lines 59-60
man/nafill.Rd Add "factor" to @param x type list

Add a grouped rolling mean example showing frolladapt + frollmean with
by= for panel data. This is the data.table equivalent of Stata's
rangestat (mean) ..., int(date -2 0) by(firm) for time-aware rolling
windows within groups respecting irregular date gaps.
- melt.data.table.Rd:59 — \code{numeric > integer > logical} had broken
  \code{} tag spanning two lines; each type now wrapped individually
- nafill.Rd:17 — @param x listed 'logical, numeric or character' but
  Details section and examples confirm factor is also supported
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 participant