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

Update documentation so that help files can be found #55

Open
nehill197 opened this issue Jul 18, 2023 · 1 comment
Open

Update documentation so that help files can be found #55

nehill197 opened this issue Jul 18, 2023 · 1 comment

Comments

@nehill197
Copy link
Member

When looking up the help file for analyse, all that comes up is the generic.
It would be ideal to have the class definitions appear as you type "?analyse".
e.g. would like ?analyse.mb_model to appear.

@sebdalgarno
Copy link
Member

bumping this - agree it is not straightforward to find documentation for embr functions
I think part of the issue is that the generics are internal functions - so have to do
?embr:::analyse.mb_model instead of ?embr::analyse.mb_model

I think the best solution would be to do ?embr::analyse and display links to documentation for each S3 method

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

2 participants