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

[R] R6 object documentation doesn't follow best practice #19678

Closed
2 of 6 tasks
lazappi opened this issue Sep 25, 2024 · 0 comments · Fixed by #19679
Closed
2 of 6 tasks

[R] R6 object documentation doesn't follow best practice #19678

lazappi opened this issue Sep 25, 2024 · 0 comments · Fixed by #19679

Comments

@lazappi
Copy link
Contributor

lazappi commented Sep 25, 2024

Bug Report Checklist

  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

The current Roxygen tags for R6 object created by the R generator do not follow recommended practice. Specifically, R6 methods should not have titles and should not be exported using the @export tag. See the {roxygen2} R6 documentation for an example of what is expected.

This causes problems if users want to create the NAMESPACE file using devtools::document() (which is the common R package development workflow) rather than the generated file as it results in non-existent objects being added to the file.

The template for the main API object also includes information about the methods for each API call but this is redundant as very similar documentation is generated by {roxygen2}, resulting in this information being duplicated in the final help file.

openapi-generator version

7.8.0

OpenAPI declaration file content or url

This problem is with documentation in the template rather than a bug caused by a particular specification

Steps to reproduce
Related issues/PRs

I couldn't find a related issue

Suggest a fix

I will submit a PR updating the template files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant