Skip to content

chore: improve README style#77

Merged
osenan merged 2 commits intomainfrom
improve-readme-style@main
May 7, 2026
Merged

chore: improve README style#77
osenan merged 2 commits intomainfrom
improve-readme-style@main

Conversation

@osenan
Copy link
Copy Markdown
Contributor

@osenan osenan commented May 7, 2026

A simple cosmetic change. The README contained code in the style my_code but the rest of teal README contain the more usual my_code. This changes the style pattern to the more normal one, which I also like more. View the README to review it.

@osenan osenan requested a review from a team May 7, 2026 15:01
@osenan osenan added the core label May 7, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

Unit Tests Summary

  1 files    9 suites   17s ⏱️
256 tests 242 ✅ 14 💤 0 ❌
384 runs  369 ✅ 15 💤 0 ❌

Results for commit b0e8a14.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

Unit Test Performance Difference

Test Suite $Status$ Time on main $±Time$ $±Tests$ $±Skipped$ $±Failures$ $±Errors$
badge_dropdown 💀 $0.15$ $-0.15$ $-1$ $-1$ $0$ $0$
Additional test case details
Test Suite $Status$ Time on main $±Time$ Test Case
assertion 👶 $+0.02$ unnamed
badge_dropdown 💀 $0.15$ $-0.15$ shinytest2_badge_dropdown_is_visible_when_clicking_on_it_multiple_times

Results for commit beb54e7

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

badge

Code Coverage Summary

Filename                  Stmts    Miss  Cover    Missing
----------------------  -------  ------  -------  -------------------------------------------------------------
R/as_picks.R                140      21  85.00%   63, 167-171, 182-186, 201-207, 229-231
R/assertion.R                 5       0  100.00%
R/call_utils.R              147      22  85.03%   23-28, 65, 132-138, 259, 279-280, 283-287, 292
R/helpers.R                   9       0  100.00%
R/interaction.R              42       1  97.62%   95
R/module_merge.R            257       2  99.22%   328, 607
R/module_picks.R            318      23  92.77%   47-53, 71, 109-110, 298-300, 302-306, 429, 478, 516, 528, 536
R/picks.R                   183       1  99.45%   335
R/print.R                    36       2  94.44%   50, 58
R/resolver.R                141      15  89.36%   110-118, 284-289
R/tidyselect-helpers.R       29       0  100.00%
R/tm_merge.R                 54      54  0.00%    42-102
R/ui_containers.R            42       0  100.00%
R/zzz.R                       5       5  0.00%    3-11
TOTAL                      1408     146  89.63%

Diff against main

Filename             Stmts    Miss  Cover
-----------------  -------  ------  --------
R/module_picks.R        +3       0  +0.07%
R/ui_containers.R       -5       0  +100.00%
TOTAL                   -2       0  -0.01%

Results for commit: b0e8a14

Minimum allowed coverage is 80%

♻️ This comment has been updated with latest results

Copy link
Copy Markdown
Contributor

@averissimo averissimo left a comment

Choose a reason for hiding this comment

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

Awesome attention to detail @osenan

Can you maybe squeeze 2 things as well?

  • Use nesttemplate in _pkgdown.yml as the template
  • Add Config/Needs/website: insightsengineering/nesttemplate to DESCRIPTION

The idea would be to make sure that DESCRIPTION and _pkgdown.yml are consistent with insightsengineering packages.

If you don't like the scope creep, open a new issue, but I think it fits this one quite well :-)

@averissimo averissimo self-assigned this May 7, 2026
@osenan osenan merged commit 9ce033d into main May 7, 2026
29 of 30 checks passed
@osenan osenan deleted the improve-readme-style@main branch May 7, 2026 20:50
@github-actions github-actions Bot locked and limited conversation to collaborators May 7, 2026
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.

2 participants