Skip to content

Improve error message source code reference #901

Open
@alandefreitas

Description

@alandefreitas

Users are confused by the format of errors messages including the location of the bug in the MrDocs source code.

For instance, the error

Failed to generate compile_commands.json file: CMake executable not found
Generating reference failed: CMake executable not found

is being rendered as:

Failed to generate compile_commands.json file: CMake executable not found

An issue occurred during execution.
If you believe this is a bug, please report it at https://github.com/cppalliance/mrdocs/issues
with the following details:
    MrDocs Version: 0.0.3 (Build: 3606a8915e8402d89858327dcbb6058ce6ca3b19)
    Error Location: `src\lib\Lib\CMakeExecution.cpp` at line 37
    Reported From: `src\tool\GenerateAction.cpp` at line 155

Generating reference failed: CMake executable not found

An issue occurred during execution.
If you believe this is a bug, please report it at https://github.com/cppalliance/mrdocs/issues
with the following details:
    MrDocs Version: 0.0.3 (Build: 3606a8915e8402d89858327dcbb6058ce6ca3b19)
    Error Location: `src\lib\Lib\CMakeExecution.cpp` at line 37
    Reported From: `src\tool\ToolMain.cpp` at line 148

We should make this second format the default for developers (because it's still quite useful especially in CI) but opt in for users so they only have to learn if they open an issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions