Improve error messages with cli #560
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #560 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 26 26
Lines 1184 1179 -5
=========================================
- Hits 1184 1179 -5
|
olivroy
commented
Sep 10, 2023
| @@ -111,7 +111,7 @@ convert_to_datetime_helper.Date <- function(x, ..., tz = "UTC", out_class = c("P | |||
| ret | |||
| } | |||
|
|
|||
| convert_to_datetime_helper.character <- function(x, ..., tz = "UTC", character_fun = lubridate::ymd_hms, string_conversion_failure = c("error", "warning"), out_class = c("POSIXct", "Date")) { | |||
| convert_to_datetime_helper.character <- function(x, ..., tz = "UTC", character_fun = lubridate::ymd_hms, string_conversion_failure = c("error", "warning"), out_class = c("POSIXct", "Date"), error_call = rlang::caller_env()) { | |||
There was a problem hiding this comment.
to ensure that it print Error in convert_date() / convert_datetime() instead of `Error in convert_to_datetime_helper
Comment on lines
+150
to
+152
| c( | ||
| "Not all character strings converted to class {.cls {out_class}}.", | ||
| i = "{n_not_converted} value{?s} not converted: {.val {not_converted_values}}" |
There was a problem hiding this comment.
Using cli pluralization + inline markup https://cli.r-lib.org/index.html#pluralization https://cli.r-lib.org/reference/inline-markup.html. Also cli automatically makes the display of values shorter, hence the removal of the code above that prepares printing of the diagnostic.
| expect_warning( | ||
| expect_error( | ||
| convert_to_date(LETTERS), | ||
| regexp = "Not all character strings converted to class Date." | ||
| ), | ||
| regexp = "All formats failed to parse." # lubridate warning | ||
| ) | ||
|
|
9 tasks
|
Maybe later! the task is large and may not be worth the trouble currently. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is just a little proof of concept of how we can improve messages in janitor, using the power of cli.
It is a little difficult to easily see the diff since we decided against using snapshot tests for errors, but I will add before and after screenshots.
If you think this is a reasonable approach, I will try replicating for other common error messages in janitor.
Related Issue
Addresses #549
Example
with this PR
convert_to_date(LETTERS)Before:
