Skip to content

Commit d875823

Browse files
Follow strict Rd rules (#7225)
* Follow strict Rd rules * Also set this in GHA to catch immediately
1 parent 00eb637 commit d875823

File tree

9 files changed

+22
-21
lines changed

9 files changed

+22
-21
lines changed

.github/workflows/R-CMD-check.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ jobs:
3636
R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
3737
RSPM: ${{ matrix.config.rspm }}
3838
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
39+
_R_CHECK_RD_CHECKRD_MINLEVEL_: -Inf
3940

4041
steps:
4142
- uses: actions/checkout@v4

man/IDateTime.Rd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,13 +70,13 @@ as.IDate(x, \dots)
7070
\method{as.IDate}{Date}(x, \dots)
7171
\method{as.Date}{IDate}(x, \dots)
7272
\method{as.POSIXct}{IDate}(x, tz = "UTC", time = 0, \dots)
73-
\method{round}{IDate}(x, digits = c("weeks", "months", "quarters","years"), \ldots)
73+
\method{round}{IDate}(x, digits = c("weeks", "months", "quarters","years"), ...)
7474

7575
as.ITime(x, \dots)
7676
\method{as.ITime}{default}(x, \dots)
7777
\method{as.ITime}{POSIXlt}(x, ms = 'truncate', \dots)
78-
\method{round}{ITime}(x, digits = c("hours", "minutes"), \ldots)
79-
\method{trunc}{ITime}(x, units = c("hours", "minutes"), \ldots)
78+
\method{round}{ITime}(x, digits = c("hours", "minutes"), ...)
79+
\method{trunc}{ITime}(x, units = c("hours", "minutes"), ...)
8080

8181
\method{as.POSIXct}{ITime}(x, tz = "UTC", date = Sys.Date(), \dots)
8282
\method{as.character}{ITime}(x, \dots)

man/between.Rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
\alias{\%between\%}
44
\alias{inrange}
55
\alias{\%inrange\%}
6-
\title{ Convenience functions for range subsets. }
6+
\title{ Convenience functions for range subsets }
77
\description{
88
Intended for use in \code{i} in \code{[.data.table}.
99

man/like.Rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
\alias{\%ilike\%}
55
\alias{\%flike\%}
66
\alias{\%plike\%}
7-
\title{ Convenience function for calling grep. }
7+
\title{ Convenience function for calling grep }
88
\description{
99
Intended for use in \code{i} in \code{\link[=data.table]{[.data.table}}, i.e., for subsetting/filtering.
1010

man/melt.data.table.Rd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ non-measure columns will be assigned to it. If integer, must be positive; see De
2424
\item{measure.vars}{Measure variables for \code{melt}ing. Can be missing, vector, list, or pattern-based.
2525
2626
\itemize{
27-
\item{ When missing, \code{measure.vars} will become all columns outside \code{id.vars}. }
28-
\item{ Vector can be \code{integer} (implying column numbers) or \code{character} (column names). }
29-
\item{ \code{list} is a generalization of the vector version -- each element of the list (which should be \code{integer} or \code{character} as above) will become a \code{melt}ed column. }
30-
\item{ Pattern-based column matching can be achieved with the regular expression-based \code{\link{patterns}} (regex without capture groups; matching column names are used in the \code{variable.name} output column), or \code{\link{measure}} (regex with capture groups; each capture group becomes an output column). }
27+
\item When missing, \code{measure.vars} will become all columns outside \code{id.vars}.
28+
\item Vector can be \code{integer} (implying column numbers) or \code{character} (column names).
29+
\item \code{list} is a generalization of the vector version -- each element of the list (which should be \code{integer} or \code{character} as above) will become a \code{melt}ed column.
30+
\item Pattern-based column matching can be achieved with the regular expression-based \code{\link{patterns}} (regex without capture groups; matching column names are used in the \code{variable.name} output column), or \code{\link{measure}} (regex with capture groups; each capture group becomes an output column).
3131
}
3232
3333
For convenience/clarity in the case of multiple \code{melt}ed columns, resulting column names can be supplied as names to the elements \code{measure.vars} (in the \code{list} and \code{patterns} usages). See also \code{Examples}. }

man/mergelist.Rd

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,24 @@
3131
The terms \emph{join-to} and \emph{join-from} indicate which in a pair of tables is the "baseline" or "authoritative" source -- this governs the ordering of rows and columns.
3232
Whether each refers to the "left" or "right" table of a pair depends on the \code{how} argument:
3333
\enumerate{
34-
\item{ \code{how \%in\% c("left", "semi", "anti")}: \emph{join-to} is \emph{RHS}, \emph{join-from} is \emph{LHS}. }
35-
\item{ \code{how \%in\% c("inner", "full", "cross")}: \emph{LHS} and \emph{RHS} tables are treated equally, so that the terms are interchangeable. }
36-
\item{ \code{how == "right"}: \emph{join-to} is \emph{LHS}, \emph{join-from} is \emph{RHS}. }
34+
\item \code{how \%in\% c("left", "semi", "anti")}: \emph{join-to} is \emph{RHS}, \emph{join-from} is \emph{LHS}.
35+
\item \code{how \%in\% c("inner", "full", "cross")}: \emph{LHS} and \emph{RHS} tables are treated equally, so that the terms are interchangeable.
36+
\item \code{how == "right"}: \emph{join-to} is \emph{LHS}, \emph{join-from} is \emph{RHS}.
3737
}
3838

3939
Using \code{mult="error"} will throw an error when multiple rows in \emph{join-to} table match to the row in \emph{join-from} table. It should not be used just to detect duplicates, which might not have matching row, and thus would silently be missed.
4040

4141
When not specified, \code{mult} takes its default depending on the \code{how} argument:
4242
\enumerate{
43-
\item{ When \code{how \%in\% c("left", "inner", "full", "right")}, \code{mult="error"}. }
44-
\item{ When \code{how \%in\% c("semi", "anti")}, \code{mult="last"}, although this is equivalent to \code{mult="first"}. }
45-
\item{ When \code{how == "cross"}, \code{mult="all"}. }
43+
\item When \code{how \%in\% c("left", "inner", "full", "right")}, \code{mult="error"}.
44+
\item When \code{how \%in\% c("semi", "anti")}, \code{mult="last"}, although this is equivalent to \code{mult="first"}.
45+
\item When \code{how == "cross"}, \code{mult="all"}.
4646
}
4747

4848
When the \code{on} argument is missing, it will be determined based \code{how} argument:
4949
\enumerate{
50-
\item{ When \code{how \%in\% c("left", right", "semi", "anti")}, \code{on} becomes the key column(s) of the \emph{join-to} table. }
51-
\item{ When \code{how \%in\% c("inner", full")}, if only one table has a key, then this key is used; if both tables have keys, then \code{on = intersect(key(lhs), key(rhs))}, having its order aligned to shorter key. }
50+
\item When \code{how \%in\% c("left", right", "semi", "anti")}, \code{on} becomes the key column(s) of the \emph{join-to} table.
51+
\item When \code{how \%in\% c("inner", full")}, if only one table has a key, then this key is used; if both tables have keys, then \code{on = intersect(key(lhs), key(rhs))}, having its order aligned to shorter key.
5252
}
5353

5454
When joining tables that are not directly linked to a single table, e.g. a snowflake schema (see References), a \emph{right} outer join can be used to optimize the sequence of merges, see Examples.

man/subset.data.table.Rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
}
1010

1111
\usage{
12-
\method{subset}{data.table}(x, subset, select, \ldots)
12+
\method{subset}{data.table}(x, subset, select, ...)
1313
}
1414

1515
\arguments{

man/test.data.table.Rd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
\name{test.data.table}
22
\alias{test.data.table}
3-
\title{ Runs a set of tests. }
3+
\title{ Runs a set of tests }
44
\description{
55
Runs a set of tests to check data.table is working correctly.
66
}

man/transform.data.table.Rd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010
\code{within}, \code{transform} and other similar functions in \code{data.table} are not just provided for users who expect them to work, but for non-data.table-aware packages to retain keys, for example. Hopefully the faster and more convenient \code{data.table} syntax will be used in time. See examples.
1111
}
1212
\usage{
13-
\method{transform}{data.table}(`_data`, \ldots)
14-
\method{within}{data.table}(data, expr, \ldots)
13+
\method{transform}{data.table}(`_data`, ...)
14+
\method{within}{data.table}(data, expr, ...)
1515
}
1616
\arguments{
1717
\item{data, _data}{ data.table to be transformed.}

0 commit comments

Comments
 (0)