Skip to content

Improve error reporting #2076

@JarrettR

Description

@JarrettR

Error reporting can be improved in the following three ways:

  1. Display the main error cause in the terminal, instead of just the logfile
  2. Use Windows-formatted line endings in the log, when necessary
  3. In the logfile, add an additional line break in the smudge error

(1)
Requiring the user to check the logfile before seeing the full text of an error seems like an unnecessary extra step that prevents quick troubleshooting. This slight obfuscation of underlying cause of errors also likely leads to vague issue reports, which is harder on the maintainers.

(2)
On Windows, checking this logfile with an application that does not support Linux-style line endings results in this, which is unusual even for cross-platform systems:

image

(3)
After converting the line endings, the relevant error message is way out on the right side of the screen, which significantly hinders reading comprehension for a user trying to parse these for the first time.

image

And extra line break after the second colon of the smudge error would fix this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions