Skip to content

R man docs missing PKGNAME-package alias #263

@Skenvy

Description

@Skenvy

Implementation Language

R

Operating System

Linux

What version of Collatz did the issue happen on (either the tag, commit hash, or semver)?

1.0.0

What semver version of the language's runtime did the issue happen on?

All

What were you doing (steps to reproduce the bug)?

Recreating the man/ docs with roxygen version > 7.0.0

What actually happened as a result?

PKGNAME-package alias was missing.

What did you expect to happen?

PKGNAME-package to exist.

If you have a stack trace, please add it here.

No response

Anything else you feel useful to add?

Dear maintainer,

You have file 'collatz/man/collatz.Rd' with \docType{package}, likely
intended as a package overview help file, but without the appropriate
PKGNAME-package \alias as per "Documenting packages" in R-exts.

This seems to be the consequence of the breaking change

Using @doctype package no longer automatically adds a -package alias.
Instead document _PACKAGE to get all the defaults for package
documentation.

in roxygen2 7.0.0 (2019-11-12) having gone unnoticed, see
r-lib/roxygen2#1491.

As explained in the issue, to get the desired PKGNAME-package \alias
back, you should either change to the new approach and document the new
special sentinel

"_PACKAGE"

or manually add

@Aliases collatz-package

if remaining with the old approach.

Please fix in your master sources as appropriate, and submit a fixed
version of your package within the next few months.

Best,
-k

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions