I'll happily fix that, I merely want to ask in advance:
When enclosing parts of strings in backticks, do you then prefer backticks + quotes, or only backticks?
I personally prefer backticks + quotes, to signify "this is code, but it's a string literal".
Here an example (look out for the curly braces):
backticks + quotes: When you print an error object using "{}" or to_string(), only the outermost underlying error is printed, not any of the lower level causes. This is exactly as if you had called the Displayimpl of the error from which you constructed your eyre::Report. [...] To print causes as well using eyre’s default formatting of causes, use the alternate selector "{:#}".
only backticks: When you print an error object using {} or to_string(), only the outermost underlying error is printed, not any of the lower level causes. This is exactly as if you had called the Displayimpl of the error from which you constructed your eyre::Report. [...] To print causes as well using eyre’s default formatting of causes, use the alternate selector {:#}.
Reading https://docs.rs/eyre/latest/eyre/struct.Report.html#display-representations I found that some items should better be enclosed in backticks.
I'll happily fix that, I merely want to ask in advance:
When enclosing parts of strings in backticks, do you then prefer backticks + quotes, or only backticks?
I personally prefer backticks + quotes, to signify "this is code, but it's a string literal".
Here an example (look out for the curly braces):
"{}"
orto_string()
, only the outermost underlying error is printed, not any of the lower level causes. This is exactly as if you had called theDisplay
impl
of the error from which you constructed youreyre::Report
. [...] To print causes as well using eyre’s default formatting of causes, use the alternate selector"{:#}"
.{}
orto_string()
, only the outermost underlying error is printed, not any of the lower level causes. This is exactly as if you had called theDisplay
impl
of the error from which you constructed youreyre::Report
. [...] To print causes as well using eyre’s default formatting of causes, use the alternate selector{:#}
.