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

various docs enhancements #182

Merged
merged 12 commits into from
Aug 22, 2023
Merged

various docs enhancements #182

merged 12 commits into from
Aug 22, 2023

Conversation

pawelru
Copy link
Contributor

@pawelru pawelru commented Aug 22, 2023

  • teal -> teal
  • teal.widgets -> teal.widgets
  • teal.widgets::foo() -> foo()
  • remove reference to beam
  • NULL -> NULL, shiny.tag -> shiny.tag, etc. (including docs, error message, testthat label)
  • add grDevices to pkg Imports - that is actually an error on the current state of main
  • update a few img test snapshots - that is actually an error on the current state of main

@pawelru pawelru added documentation Improvements or additions to documentation core labels Aug 22, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 22, 2023

Unit Tests Summary

    1 files    10 suites   22s ⏱️
101 tests 101 ✔️ 0 💤 0
208 runs  208 ✔️ 0 💤 0

Results for commit 504dc67.

♻️ This comment has been updated with latest results.

R/standard_layout.R Outdated Show resolved Hide resolved
R/basic_table_args.R Outdated Show resolved Hide resolved
DESCRIPTION Outdated
@@ -29,6 +29,7 @@ Imports:
shinyWidgets,
styler
Suggests:
grDevices,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixing previous mistake of not adding a package that is used in the tests

Copy link
Contributor Author

Choose a reason for hiding this comment

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

actually this should be even in imports as one functionality depends on this!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is on main now:

grDevices::pdf(NULL) # reset Rplots.pdf for shiny server
w <- grDevices::dev.size("px")[1]
grDevices::dev.off()

@@ -21,6 +21,7 @@ Imports:
checkmate,
ggplot2,
graphics,
grDevices,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

FYI @averissimo - change in deps

@github-actions
Copy link
Contributor

github-actions bot commented Aug 22, 2023

badge

Code Coverage Summary

Filename                   Stmts    Miss  Cover    Missing
-----------------------  -------  ------  -------  --------------------------------------------
R/basic_table_args.R          23       0  100.00%
R/draggable_buckets.R         82      82  0.00%    57-152
R/get_dt_rows.R               13      13  0.00%    27-39
R/ggplot2_args.R              49       0  100.00%
R/include_css_js.R             7       1  85.71%   17
R/optionalInput.R            225     182  19.11%   87-362, 414, 465, 471, 486-499
R/panel_group.R               89      89  0.00%    12-130
R/plot_with_settings.R       382      21  94.50%   272-285, 344-345, 356-357, 607-608, 610, 612
R/standard_layout.R           35       0  100.00%
R/table_with_settings.R      173       1  99.42%   79
R/utils.R                     11       1  90.91%   7
R/verbatim_popup.R            99      49  50.51%   63-78, 104-105, 107, 115-143, 164
R/white_small_well.R           7       7  0.00%    18-24
TOTAL                       1195     446  62.68%

Diff against main

Filename               Stmts    Miss  Cover
-------------------  -------  ------  --------
R/optionalInput.R         +7      -3  +3.97%
R/standard_layout.R       -5       0  +100.00%
R/verbatim_popup.R        -1       0  -0.49%
TOTAL                     +1      -3  +0.28%

Results for commit: 6fa9a2c

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Contributor

@chlebowa chlebowa left a comment

Choose a reason for hiding this comment

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

some more minor tweaks

R/optionalInput.R Outdated Show resolved Hide resolved
R/standard_layout.R Outdated Show resolved Hide resolved
R/standard_layout.R Outdated Show resolved Hide resolved
R/teal.widgets-package.R Outdated Show resolved Hide resolved
Copy link
Contributor

@chlebowa chlebowa left a comment

Choose a reason for hiding this comment

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

Exploding PRs happen all too often 😉

R/optionalInput.R Outdated Show resolved Hide resolved
R/optionalInput.R Outdated Show resolved Hide resolved
Copy link
Contributor

@chlebowa chlebowa left a comment

Choose a reason for hiding this comment

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

yup 👌

@pawelru pawelru merged commit e1d81a9 into main Aug 22, 2023
23 checks passed
@pawelru pawelru deleted the docs_enhancements branch August 22, 2023 15:33
@pawelru
Copy link
Contributor Author

pawelru commented Aug 22, 2023

@chlebowa thanks for a good review comments!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants