Skip to content

diagnostics: span_note/span_help/etc should work with dummy spans #55669

Closed

Description

@petrochenkov

span_note and friends require this non-obvious pattern to work correctly:

if span.is_dummy() {
    err.note(msg);
} else {
    err.span_note(span, msg);
}

If dummy span is passed to span_note then the message simply won't be displayed, but with note it will be attached to the primary err message.
The difference is that note turns into an empty multi-span, but span_note turns into multi-span containing a single dummy span.

I think span_note should "just work" with dummy spans and display the message equivalently to note.

Activity

  1. petrochenkov commented on Nov 4, 2018

    @petrochenkov
    ContributorAuthor
  2. eddyb commented on Nov 4, 2018

    @eddyb
    Contributor
  3. estebank commented on Nov 4, 2018

    @estebank
    Contributor

    Now multispans also have an is_dummy() method, so that won't be a source of problems. The only thing that I can think of that could present a challenge is for suggestions (which I guess are out of scope for this thicket) they usually have a fallback with tweaked wording to work as note/help.

    I can write out mentoring notes for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-diagnosticsArea: Messages for errors, warnings, and lints

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions