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

Better communication if styler.cache_root is not set. #1063

Merged
merged 5 commits into from
Nov 19, 2022
Merged

Conversation

lorenzwalthert
Copy link
Collaborator

Addresses #1058.

@codecov-commenter
Copy link

codecov-commenter commented Nov 17, 2022

Codecov Report

Merging #1063 (45f25e8) into main (8859cc3) will not change coverage.
The diff coverage is n/a.

❗ Current head 45f25e8 differs from pull request most recent head b74067c. Consider uploading reports for the commit b74067c to get more accurate results

@@           Coverage Diff           @@
##             main    #1063   +/-   ##
=======================================
  Coverage   91.05%   91.05%           
=======================================
  Files          46       46           
  Lines        2682     2682           
=======================================
  Hits         2442     2442           
  Misses        240      240           
Impacted Files Coverage Δ
R/ui-caching.R 89.74% <ø> (ø)
R/io.R 88.67% <0.00%> (ø)
R/nest.R 100.00% <0.00%> (ø)
R/parse.R 87.95% <0.00%> (ø)
R/visit.R 94.79% <0.00%> (ø)
R/addins.R 14.28% <0.00%> (ø)
R/indent.R 100.00% <0.00%> (ø)
R/testing.R 66.66% <0.00%> (ø)
R/reindent.R 100.00% <0.00%> (ø)
R/unindent.R 95.83% <0.00%> (ø)
... and 20 more

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 538e64d is merged into main:

  •   :ballot_box_with_check:cache_applying: 32.9ms -> 32.8ms [-1.8%, +1.15%]
  •   :ballot_box_with_check:cache_recording: 1s -> 1s [-1.12%, +2.07%]
  •   :ballot_box_with_check:without_cache: 2.52s -> 2.52s [-1.24%, +1.48%]

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

R/ui-caching.R Outdated Show resolved Hide resolved
Copy link
Collaborator

@IndrajeetPatil IndrajeetPatil left a comment

Choose a reason for hiding this comment

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

Thanks!

@IndrajeetPatil
Copy link
Collaborator

IndrajeetPatil commented Nov 18, 2022

Hmm, looks like we might need to add {usethis} to Suggests to avoid this NOTE (which is acceptable by CRAN, btw):

Package unavailable to check Rd xrefs: ‘usethis’

Either that, or we set the following environment variable in our GHA workflow:

      - uses: r-lib/actions/check-r-package@v2
        with:
          error-on: '"note"'
        env:
          _R_CHECK_RD_XREFS_: false

Which way should we go?

@github-actions
Copy link
Contributor

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

  •   :ballot_box_with_check:cache_applying: 23.5ms -> 23.7ms [-0.32%, +2.26%]
  •   :ballot_box_with_check:cache_recording: 722ms -> 721ms [-0.55%, +0.08%]
  •   :ballot_box_with_check:without_cache: 1.81s -> 1.81s [-0.18%, +0.64%]

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

@lorenzwalthert
Copy link
Collaborator Author

Well we'll have to fix the note earlier or later, so I think it's fine to fail on note. Rather, we could turn the clickable reference to {usethis} with an unclickable one or add it to Suggests:. I think unclickable (and just code font) is fine.

@IndrajeetPatil
Copy link
Collaborator

I think unclickable (and just code font) is fine.

Yes, I would personally prefer this option over acquiring a new soft dependency just so that one function can be clickable in the docs.

@github-actions
Copy link
Contributor

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

  •   :ballot_box_with_check:cache_applying: 24.5ms -> 24.7ms [-0.05%, +1.09%]
  •   :ballot_box_with_check:cache_recording: 760ms -> 761ms [-0.38%, +0.63%]
  •   :ballot_box_with_check:without_cache: 1.91s -> 1.92s [-0.37%, +0.65%]

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