Skip to content

The default-on CRAN checker does not understand @rdname #12

@eddelbuettel

Description

@eddelbuettel

tinyrox rocks. Getting my first package baked with it, and it is of course 'tiny' but out here: tl.

When I use my default wrapper from littler which runs tinyrox::document() then for this package with its (essentially sole) Rd block and a bunch of @rdname pointing to it, it false claims 'undocumented' which aint't true:

tinyrox

edd@paul:~/git/tl(master)$ tt.r -d inst/tinytest/
test_basics.R.................   25 tests OK 50ms
test_formats.R................   19 tests OK 4ms
All ok, 44 results (54ms)
edd@paul:~/git/tl(master)$ trox.r 
Checking CRAN compliance...
Parsing R files...
Found 11 documentation block(s).
Generating Rd files...
Generated 1 Rd file(s).
Generating NAMESPACE...
Updated NAMESPACE.
Warning messages:
1: CRAN: Exported functions without examples: debug, info, warn, error, critical, set_level, get_level, set_name, get_name, set_format 
2: Undocumented parameters in set_format: utc, show_date, show_thread_id, precision 
edd@paul:~/git/tl(master)$ 

R CMD check (subset via rcmdcheck::rcmdcheck() via rcc.r)

[...]
✔  checking R code for possible problems (422ms)
✔  checking Rd files ...
✔  checking Rd metadata ...
✔  checking Rd cross-references ...
✔  checking for missing documentation entries ...
✔  checking for code/documentation mismatches ...
✔  checking Rd \usage sections ...
✔  checking Rd contents ...
✔  checking for unstated dependencies in examples ...
✔  checking line endings in shell scripts
[...]
── R CMD check results ───────────────────────────────────── tl 0.0.1 ────
Duration: 5.6s

0 errors ✔ | 0 warnings ✔ | 0 notes ✔
edd@paul:~/git/tl(master)$ 

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions