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

Misc doc edits #936

Merged
merged 3 commits into from Feb 12, 2024
Merged

Misc doc edits #936

merged 3 commits into from Feb 12, 2024

Conversation

olivroy
Copy link
Collaborator

@olivroy olivroy commented Feb 12, 2024

Not yet done for the vignette, but thought I'd send these editorial changes.

I adapted what you put in openxlsx2-package to add to the class docs.

Corrected a link in README that takes us to an unused page as well.

Copy link
Owner

@JanMarvin JanMarvin left a comment

Choose a reason for hiding this comment

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

Thanks and good catch!

I was wondering, if we should add more #' @inherits details wb_foo in the class workbook documentation, because currently it is a long and rather useless dump of #' @param foo foo graveyard. But I haven't looked into this and *sigh* I do not really care enough

@olivroy
Copy link
Collaborator Author

olivroy commented Feb 12, 2024

I can check it out, but there are still many bugs in roxygen2 R6 handling, so I don't think it is worth playing there, unless you find it difficult to maintain!

@olivroy olivroy merged commit 29c4c76 into main Feb 12, 2024
9 checks passed
@olivroy olivroy deleted the title branch February 12, 2024 19:52
@JanMarvin
Copy link
Owner

Oh alright, probably not worth the hassle. Though I somehow doubt that they will be ever solved.

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

Successfully merging this pull request may close these issues.

None yet

2 participants