149 revise documentation

[m7pr]

Close #149

[m7pr]

Hey @donyunardi I prepared few improvements for #149. Some comments were outdated, so please check comments in #149 to see what was omitted. While going through this issue I noticed we could do

• [Feature Request]: Revisit @param + @return tags and lifecycle badges #227
• [Question]: Should we join documentation of panel_group and panel_item #228
• [Feature Request]: Reorganize roxygen2 tags #229

At the end of the day I think this was a weird issue, since we tried to provide examples for a lot of utility functions that are used outside of the package to build tmg and tmc modules and encodings panel. So it was hard to create condensed examples, that would focus only on a specific function, which comes with a lot of other functions. Separately some functions just are out of context and do not have much sense.

Maybe we should create an extra vignette covering those?

[github-actions]

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%    44-56
R/ggplot2_args.R                 49       0  100.00%
R/include_css_js.R                7       1  85.71%   17
R/nested_closeable_modal.R       16      16  0.00%    83-98
R/optionalInput.R               255     212  16.86%   149-447, 501, 554, 560, 575-588
R/panel_group.R                  90      90  0.00%    50-190
R/plot_with_settings.R          382      21  94.50%   294-307, 366-367, 378-379, 653-654, 656, 658
R/standard_layout.R              35       0  100.00%
R/table_with_settings.R         173       1  99.42%   85
R/utils.R                        14       1  92.86%   7
R/verbatim_popup.R               99      49  50.51%   64-79, 105-106, 108, 116-144, 165
R/white_small_well.R              7       7  0.00%    19-25
TOTAL                          1245     493  60.40%

Diff against main

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

Results for commit: 126888e

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

[github-actions]

Unit Tests Summary

  1 files   10 suites   14s ⏱️
101 tests 101 ✅ 0 💤 0 ❌
208 runs  208 ✅ 0 💤 0 ❌

Results for commit 126888e.

♻️ This comment has been updated with latest results.

[donyunardi]

Thanks @m7pr!
Just small comments and this is good to go!

[m7pr]

Changes incorporated @donyunardi . Take a look, when you have some spare time.

[donyunardi]

LGTM!
And thanks for creating new issue about the panel widget so we can move forward with this PR.