6 Error messages
An error message should start with a general statement of the problem then give a concise description of what went wrong. Consistent use of punctuation and formatting makes errors easier to parse.
(This guide is currently almost entirely aspirational; most of the bad examples come from existing tidyverse code.)
6.1 Problem statement
Every error message should start with a general statement of the problem. It should be concise, but informative. (This is hard!)
If the cause of the problem is clear use “must”:
Clear cut causes typically involve incorrect types or lengths.
If you cannot state what was expected, use “can’t”:
stop(call. = FALSE),
Rf_errorcall(R_NilValue, ...) to
avoid cluttering the error message with the name of the function that generated
it. That information is often not informative, and can easily be accessed via
traceback() or an IDE equivalent.
6.2 Error location
Do your best to reveal the location, name, and/or content of the troublesome component. The goal is to make it easy as possible for the user to find and fix the problem.
(It is often not easy to identify the exact problem; it may require passing around extra arguments so that error messages generated at a lower-level can know the original source. For frequently used functions, the effort is typically worth it.)
If the source of the error is unclear, avoid pointing the user in the wrong direction by giving an opinion about the source of the error:
# GOOD pull(mtcars, b) #> Error: Can't find column `b` in `.data`. tibble(x = 1:2, y = 1:3, z = 1) #> Error: Columns must have consistent lengths: #> * Column `x` has length 2 #> * Column `y` has length 3 # BAD: implies one argument at fault pull(mtcars, b) #> Error: Column `b` must exist in `.data` pull(mtcars, b) #> Error: `.data` must contain column `b` tibble(x = 1:2, y = 1:3, z = 1) #> Error: Column `x` must be length 1 or 3, not 2
If there are multiple issues, or an inconsistency revealed across several arguments or items, prefer a bulleted list:
If the source of the error is clear and common, you may want provide a hint as how to fix it:
Hints should always end in a question mark.
Hints are particularly important if the source of the error is far away from the root cause:
Good hints are difficult to write because, as above, you want to avoid steering users in the wrong direction. Generally, I avoid writing a hint unless the problem is common, and you can easily find a common pattern of incorrect usage (e.g. by searching StackOverflow).
Errors should be written in sentence case, and should end in a full stop. Bullets should be formatted similarly; make sure to capitalise the first word (unless it’s an argument or column name).
Prefer the singular in problem statements:
If you can detect multiple problems, list up to five. This allows the user to fix multiple problems in a single pass without being overwhelmed by many errors that may have the same source.
Pick a natural connector between problem statement and error location: this may be “, not”, “;”, or “:” depending on the context.
Surround the names of arguments in backticks, e.g.
`x`. Use “column” to disambiguiate columns and arguments:
Column `x`. Avoid “variable”, because it is ambiguous.
Ideally, each component of the error message should be less than 80 characters wide. Do not add manual line breaks to long error messages; they will not look correct if the console is narrower (or much wider) than expected. Instead, use bullets to break up the error into shorter logical components.
6.5 Before and after
More examples gathered from around the tidyverse.
dplyr::filter(mtcars, cyl) #> BEFORE: Argument 2 filter condition does not evaluate to a logical vector #> AFTER: Each argument must be a logical vector: #> * Argument 2 (`cyl`) is an integer vector. tibble::tribble("x", "y") #> BEFORE: Expected at least one column name; e.g. `~name` #> AFTER: Must supply at least one column name, e.g. `~name`. ggplot2::ggplot(data = diamonds) + ggplot2::geom_line(ggplot2::aes(x = cut)) #> BEFORE: geom_line requires the following missing aesthetics: y #> AFTER: `geom_line()` must have the following aesthetics: `y`. dplyr::rename(mtcars, cyl = xxx) #> BEFORE: `xxx` contains unknown variables #> AFTER: Can't find column `xxx` in `.data`. dplyr::arrange(mtcars, xxx) #> BEFORE: Evaluation error: object 'xxx' not found. #> AFTER: Can't find column `xxx` in `.data`.