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

Correct docs for R6 classes #123

Merged
merged 5 commits into from
Jan 31, 2024
Merged

Correct docs for R6 classes #123

merged 5 commits into from
Jan 31, 2024

Conversation

olivroy
Copy link
Contributor

@olivroy olivroy commented Aug 16, 2023

See https://rstudio.github.io/chromote/reference/Chromote.html
There is a bug on the top of the page.

This correction is done to circumvent r-lib/roxygen2#1504

Edit: changes to the R files could be reverted once the issue is fixed.

@CLAassistant
Copy link

CLAassistant commented Aug 16, 2023

CLA assistant check
All committers have signed the CLA.

@olivroy olivroy changed the title Correct docs Correct docs for R6 classes Aug 16, 2023
@gadenbuie
Copy link
Member

Thanks for pointing this out to us @olivroy. I understand this doesn't look as good as it possibly could, but it sounds like a fix will be applied upstream. As long as our documentation is still readable and functional, I'd prefer to just wait for the upstream fix at which point this will resolve itself.

@hadley
Copy link
Member

hadley commented Jan 30, 2024

@gadenbuie it's probably going to be a while until a fix gets into roxygen2, so I think you should merge this PR.

R/chromote.R Outdated Show resolved Hide resolved
Copy link
Member

@gadenbuie gadenbuie left a comment

Choose a reason for hiding this comment

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

Thank you @olivroy!

@wch or @hadley, I'll let you handle merging since you're actively working on chromote.

R/chromote.R Outdated Show resolved Hide resolved
@olivroy
Copy link
Contributor Author

olivroy commented Jan 31, 2024

Only need to redocument and this would be ok to go

@hadley hadley merged commit 454e194 into rstudio:main Jan 31, 2024
12 checks passed
@olivroy olivroy deleted the docs branch January 31, 2024 14:32
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.

4 participants