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

Tweaks to style_pkg() #977

Merged
merged 3 commits into from
Aug 21, 2022
Merged

Tweaks to style_pkg() #977

merged 3 commits into from
Aug 21, 2022

Conversation

krlmlr
Copy link
Member

@krlmlr krlmlr commented Aug 21, 2022

  • Simplify description thans to new defaults
  • Simplify argument documentation
  • Avoid styling R/cpp11.R by default, even if it's harmless

Follow-up to #965.

@github-actions
Copy link
Contributor

This is how benchmark results would change (along with a 95% confidence interval in relative change) if dd5e0ab is merged into main:

  •   :ballot_box_with_check:cache_applying: 30.8ms -> 30.9ms [-0.37%, +1.4%]
  •   :ballot_box_with_check:cache_recording: 1.29s -> 1.29s [-0.63%, +0.5%]
  •   :ballot_box_with_check:without_cache: 3.42s -> 3.42s [-0.4%, +0.37%]

Further explanation regarding interpretation and methodology can be found in the documentation.

@lorenzwalthert
Copy link
Collaborator

Thanks Kirill. I think as we discussed in #965, changes in default arguments should probably not constitute a breaking change, in particular not excluding files, so I think we can release that with the next non-major release.

If there are oblivious style issues that are easy to fix in the {cpp11} generated file, can we also fix the generation of that file easily?

Also, for next time, can you add a news bullet in NEWS.md? I can do this time.

@krlmlr
Copy link
Member Author

krlmlr commented Aug 21, 2022

Would you be open to using fledge in this project? It's a lot better now, and we'll never need to think about manually adding stuff to NEWS.md again.

The cpp11.R file typically looks good, until it doesn't. This might be the reason why nobody noticed or complained. Nothing to fix there AFAICT, still generated files should be excluded. (Should we watch out for a "do not edit" header in the file too?)

I came here because a change in default arguments broke my workflows 🙃

@codecov-commenter
Copy link

Codecov Report

Merging #977 (a4e115b) into main (2fa7369) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #977   +/-   ##
=======================================
  Coverage   90.12%   90.12%           
=======================================
  Files          47       47           
  Lines        2664     2664           
=======================================
  Hits         2401     2401           
  Misses        263      263           
Impacted Files Coverage Δ
R/ui-styling.R 100.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@github-actions
Copy link
Contributor

This is how benchmark results would change (along with a 95% confidence interval in relative change) if cf17b2e is merged into main:

  •   :ballot_box_with_check:cache_applying: 34.4ms -> 34.5ms [0%, +1.01%]
  •   :ballot_box_with_check:cache_recording: 1.44s -> 1.44s [-0.46%, +0.35%]
  •   :ballot_box_with_check:without_cache: 3.82s -> 3.83s [-0.06%, +0.59%]

Further explanation regarding interpretation and methodology can be found in the documentation.

@lorenzwalthert lorenzwalthert merged commit 88ee57c into main Aug 21, 2022
@lorenzwalthert lorenzwalthert deleted the f-ui-tweaks branch August 21, 2022 06:50
@github-actions
Copy link
Contributor

This is how benchmark results would change (along with a 95% confidence interval in relative change) if f7c6189 is merged into main:

  •   :ballot_box_with_check:cache_applying: 27.6ms -> 27.7ms [-0.43%, +1.03%]
  •   :ballot_box_with_check:cache_recording: 1.12s -> 1.12s [-0.32%, +0.7%]
  •   :ballot_box_with_check:without_cache: 2.99s -> 2.98s [-0.92%, +0.21%]

Further explanation regarding interpretation and methodology can be found in the documentation.

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

Successfully merging this pull request may close these issues.

3 participants