Less verbose box_alphabetical_calls_linter()

[radbasa]

Issue #118

Description

• Adds a verbose switch to box_alphabetical_calls_linter().
• Defaults to FALSE.
• Updated tests.
• Reports first unsorted function in box function list.

Definition of Done

• The change is thoroughly documented.
• The CI passes (R CMD check, linter, unit tests, spelling).
• Any generated files have been updated (e.g. .Rd files with roxygen2::roxygenise())

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.00%. Comparing base (1a31217) to head (a744f64).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #119   +/-   ##
=======================================
  Coverage   97.99%   98.00%           
=======================================
  Files          22       22           
  Lines        1046     1050    +4     
=======================================
+ Hits         1025     1029    +4     
  Misses         21       21           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[kamilzyla]

Nice, kudos for quick reaction! 🎉

I'd suggest to make this linter less verbose by default and not even provide any switch. I think just pointing to the beginning of the unsorted list is enough; pointing to each element separately is just noise.

Idea: perhaps it would be even better to point to the first out-of-order element of the list. This would be helpful in situations where it is not clear what is the alphabetical order (e.g. due to special characters).

[radbasa]

That "point to the first out-of-order element of the [function] list" is a great idea.

[jakubnowicki]

LGTM