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 doc R6, fix docs check #530

Merged
merged 10 commits into from
Jun 11, 2020
Merged

Conversation

meztez
Copy link
Collaborator

@meztez meztez commented Apr 19, 2020

per #522

updated documentation on R6 class
fix doc link for sodium random -> helpers
added custom swagger spec examples

comments welcome

mental check list:
remove deprecated plumber methods? or mark for deletion
should we add more documentation to initialize of PlumberEndpoint and PlumberStep?
should they even be exported? Maybe for historical reason.

PR task list:

  • Update NEWS
  • Add tests
  • Update documentation with devtools::document()

R/plumber-static.R Outdated Show resolved Hide resolved
R/plumber-static.R Outdated Show resolved Hide resolved
meztez and others added 2 commits June 8, 2020 14:33
Co-authored-by: Barret Schloerke <barret@rstudio.com>
Co-authored-by: Barret Schloerke <barret@rstudio.com>
R/plumber-step.R Outdated Show resolved Hide resolved
@schloerke
Copy link
Collaborator

should we add more documentation to initialize of PlumberEndpoint and PlumberStep?
should they even be exported? Maybe for historical reason.

We need to keep them for historical reasons. They can be minimally documented.

Can we add a @keywords internal so that we don't have to do a pkgdown link, but documentation is still produced?

@schloerke schloerke added this to the v0.5.0 - Next CRAN release milestone Jun 8, 2020
@meztez
Copy link
Collaborator Author

meztez commented Jun 8, 2020

I'll let you go through this and I'll circle around later.

@meztez meztez closed this Jun 8, 2020
@meztez meztez reopened this Jun 8, 2020
R/plumber.R Outdated Show resolved Hide resolved
R/session-cookie.R Outdated Show resolved Hide resolved
Copy link
Collaborator

@schloerke schloerke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small changes requested above.

@schloerke schloerke added the docs Related to documentation only label Jun 8, 2020
meztez and others added 5 commits June 10, 2020 14:16
Co-authored-by: Barret Schloerke <barret@rstudio.com>
Co-authored-by: Barret Schloerke <barret@rstudio.com>
Co-authored-by: Barret Schloerke <barret@rstudio.com>
Co-authored-by: Barret Schloerke <barret@rstudio.com>
@schloerke schloerke requested review from cpsievert and schloerke June 10, 2020 20:33
@schloerke schloerke merged commit 6122cfc into rstudio:master Jun 11, 2020
@meztez meztez deleted the R6_docs_roxygen2 branch June 24, 2020 23:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to documentation only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants