Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Usage section not automatically rendered for iSEE method #1636

Closed
RiboRings opened this issue Jul 16, 2024 · 1 comment
Closed

Usage section not automatically rendered for iSEE method #1636

RiboRings opened this issue Jul 16, 2024 · 1 comment

Comments

@RiboRings
Copy link

Hi!

When oxygenising the vignettes for the iSEE function in the package iSEEtree, the Usage section is not automatically rendered (online docs available here). Notably, this function is already defined and documented in the iSEE package, and in iSEEtree I am just creating a method for a new class. I tried inheriting the params with @inheritParams iSEE::iSEE. However, this threw the following error:

✖ In topic 'iSEE': @inheritParams failed.
ℹ All parameters are already documented; none remain to be inherited.

Am I doing something wrong? How can I report/inherit the original usage section of the iSEE function in the iSEEtree package?

Thank you for the great package!

@RiboRings
Copy link
Author

It got fixed after adding @Rdname to the function

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

No branches or pull requests

1 participant