Skip to content

MrDocs error message confusing between internal and user errorsΒ #1116

@mizvekov

Description

@mizvekov

When there is any kind of error in the mrdocs tool execution, it produces:

  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.8.0 (Build: ad5dbb241f9bfa2088e0163a7396f45ad586f9fa)
      Reported From: `src/lib/Metadata/Finalizers/DocCommentFinalizer.cpp` at line 1721

This happens regardless if this was an internal error, or if this is a user error, for example an undocumented entity warning, with warnings as errors enabled.

Ideally this kind of message should only be produced for internal errors, and we should trust that user errors are not mrdocs' problem.

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