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

Document that having rapidoc installed is useful #27

Closed
DavisVaughan opened this issue Oct 20, 2021 · 3 comments
Closed

Document that having rapidoc installed is useful #27

DavisVaughan opened this issue Oct 20, 2021 · 3 comments

Comments

@DavisVaughan
Copy link
Contributor

i.e. it is used here if installed
https://github.com/tidymodels/vetiver/blob/579a5425db2c6ad9e8668d3edcaaaea47a12086d/R/pr-predict.R#L55

it would be useful to mention in the docs for this function that having it installed does something.


Alternatively it may be a little nicer to add a document = FALSE/TRUE argument that will only try to run that chunk of code if document = TRUE. It would fail if document = TRUE and rapidoc isn't installed. The parameter documentation for document would be a great place to mention rapidoc as well

@DavisVaughan
Copy link
Contributor Author

This seems to have some connection to vetiver_write_plumber(docs =)

@juliasilge
Copy link
Member

You know, I have decided it is overkill for this first release to support folks choosing any kind of visual documentation. I'm just going to import rapidoc and use it only. If folks want that as a feature, I can revisit it.

@juliasilge
Copy link
Member

Closed in 304cfbf

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