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

Match code and documentation #299

Merged
merged 3 commits into from
Jan 22, 2025
Merged

Match code and documentation #299

merged 3 commits into from
Jan 22, 2025

Conversation

llrs-roche
Copy link
Contributor

While checking for other issues I noticed in the examples some mismatch between the text and the result.
I also observed some differences between the options on the code and the documented options.

While checking the package I saw:

─  checking examples ... [22s] OK (23.2s)
   Examples with CPU (user + system) or elapsed time > 5s
            user system elapsed
   Reporter 2.61   0.14    7.09
   Renderer 2.30   0.30    7.74

The problem might come from each method creating a new card and reporter, see r-lib/roxygen2#1521 for the underlying issue and linked issues here.

Copy link
Contributor

github-actions bot commented Jan 21, 2025

Unit Tests Summary

  1 files   19 suites   28s ⏱️
197 tests 197 ✅ 0 💤 0 ❌
337 runs  337 ✅ 0 💤 0 ❌

Results for commit 52cf6c8.

♻️ This comment has been updated with latest results.

@vedhav
Copy link
Contributor

vedhav commented Jan 21, 2025

We can also bump the rtables.officer version because it has a CRAN release now.

@llrs-roche
Copy link
Contributor Author

Thanks Vedha! I updated rtables.officer and rtables versions

@m7pr m7pr assigned vedhav and m7pr Jan 22, 2025
@llrs-roche llrs-roche merged commit e4b0145 into main Jan 22, 2025
29 checks passed
@llrs-roche llrs-roche deleted the fix_docs@main branch January 22, 2025 15:24
@github-actions github-actions bot locked and limited conversation to collaborators Jan 22, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants