post-release-cleanup

[kartikeyakirar]

this PR is part of #246

I have added few changes to keep it consistent with other pre-release-cleanup

• title and description to have sentence cases.
• common document for module instead of separate for UI and server
  • download_report_button
  • add_card_button
  • reporter_previewer
  • reset_report_button
  • simple_reporter
• removing indentation-linter
• removing \cr tags
• putting backticks on keywords e.g R6, shiny or [pkg]
• removing pkg:: call from examples and use library(pkg)

[github-actions]

Code Coverage Summary

Filename              Stmts    Miss  Cover    Missing
------------------  -------  ------  -------  -----------------------------------------------------------------------------------
R/AddCardModule.R       144       2  98.61%   165, 202
R/Archiver.R             25       0  100.00%
R/ContentBlock.R         18       2  88.89%   57-63
R/DownloadModule.R      207      49  76.33%   98-104, 146, 177-182, 191-195, 198-202, 210-214, 217-221, 228-232, 235-239, 278-282
R/FileBlock.R            13       0  100.00%
R/NewpageBlock.R          2       0  100.00%
R/PictureBlock.R         30       2  93.33%   20, 118
R/Previewer.R           295      56  81.02%   198, 213, 215-218, 221, 224-232, 346-390
R/RcodeBlock.R           15       0  100.00%
R/Renderer.R            113      37  67.26%   97-112, 216, 224, 233, 235-256
R/ReportCard.R           77       4  94.81%   192, 233, 238, 259
R/Reporter.R             94       1  98.94%   270
R/ResetModule.R          55       0  100.00%
R/SimpleReporter.R       30       0  100.00%
R/TableBlock.R            9       0  100.00%
R/TextBlock.R            13       0  100.00%
R/utils.R               171      80  53.22%   7, 38-97, 99, 102-109, 167, 179-181, 285-294
R/yaml_utils.R           81       2  97.53%   79, 290
R/zzz.R                  14      10  28.57%   2-13, 19
TOTAL                  1406     245  82.57%

Diff against main

Filename      Stmts    Miss  Cover
----------  -------  ------  --------
TOTAL             0       0  +100.00%

Results for commit: 37db571

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   18 suites   12s ⏱️
204 tests 204 ✅ 0 💤 0 ❌
346 runs  346 ✅ 0 💤 0 ❌

Results for commit 37db571.

♻️ This comment has been updated with latest results.

[vedhav]

Wow, nice changes! Since this is not targeting the main the actions are not triggered. Can you try running lintr::lint_package() and catch the lint errors?

[kartikeyakirar]

thanks @vedhav , I have fixed the linter issue.

[vedhav]

LGTM! You're becoming a doc-fixing ninja 🥷
Ready to merge after the pkgdown fix.

[averissimo]

I think the skipping Suggest packages in examples, tests & vignettes should become its own issue as it will require some code changes in tests.

Created: #248

[averissimo]

Solves the _pkgdown.yml problem with building site

Built locally

[kartikeyakirar]

Thank you, @chlebowa and @vedhav, for your review and approval. I've made some updates to the documentation and vignette and have pushed these changes. Could you please take a look at this commit? before final merge 7fd7c87

[chlebowa]

No major comments at this time.

[github-actions]

Unit Test Performance Difference

Additional test case details

Test Suite	$Status$	Time on main	$±Time$	Test Case
PictureBlock	👶		$+0.01$	set_content_raises_error_if_the_content_is_not_of_the_supported_type
PictureBlock	💀	$0.01$	$-0.01$	set_content_throws_if_the_content_is_not_of_the_supported_type

Results for commit bf714db

♻️ This comment has been updated with latest results.