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
Documenting private R6 fields ends up in the Public fields section #1145
Comments
|
Where do you want the documentation of the private fields go? |
|
Honestly, I think |
|
Putting the documentation of private fields in the manual is not currently supported. The manual is for the end user, and the end user has no access to these fields, they are not part of the public API of the class. |
|
That's fine. Then they should not be included anyways. |
|
currently (roxygen2 7.1.1) i get errors (or warnings, or notices, ...) when writing documentation for things in R6 private fields. i like using roxygen2 as a template for writing consistent documentation, for public/exported as well as private/non-exported functions/fields. for me, it would be great to parse and complain about syntax errors, and otherwise ignore private/non-exported. (so, this applies to non-R6 documentation of non-exported functions from my package, say -- i don't think there is a notice, but i do think they end up being available for thanks for it! |
|
Thanks for filing this issue! Unfortunately, I don't think it's a good fit for this package: developing good software requires relentless focus, which means that we have to say no to many good ideas. Even though I'm closing this issue, I really appreciate the feedback, and hope you'll continue to contribute in the future |
While attempting to document my R6 classes, I encountered this:
When documenting private fields, the field name suddenly appears in the public field's section of
the documentation.
Here's an example
And the resulting
.Rdfile:The above seem hard to understand, here's a screenshot:
The text was updated successfully, but these errors were encountered: