Ignore a particular line (# pyright: ignore)

[savchenko]

I am using pyright with NeoVim via lspconfig. In code, I have the following line:

from . import routes  # pyright: ignore

Despite the ignore instruction, pyright LSP sets the following:

DiagnosticUnnecessary vim.lsp.pyright.2/diagnostic/underline

Similarly, # noqa does nothing (which is somewhat expected given the #144).

How do I tell pyright to ignore all imports, but only for a particular line?

[erictraut]

There is no way to individually suppress tagged hints. These are not intended to be displayed as regular diagnostics. They are unaffected by # pyright: ignore, which affect only regular diagnostics. Clients should render tagged hints as "dimmed" text. See VS Code for the intended behavior. Some clients unfortunately render tagged hints as regular diagnostics. If your client does this, you can tell pyright to disable all tagged hints by setting pyright.disableTaggedHints to true. See this documentation for a full list of language server settings.

[savchenko]

Here is how it would render it:

Of course, vim being vim there is plethora of possible options, including the in-line display:

I can disable the text altogether, but this doesn't prevent the hint (H on the side, designated as DiagnosticSignHint) and highlight:

It can be disabled globally of course, but again, this is not my intention.

Any particular reason why they can't (shouldn't?) be individually "toggleable"?

[erictraut]

Any particular reason why they can't (shouldn't?) be individually "toggleable"?

Because these are not intended to be diagnostics. They're meant to be rendered as a subtle visual clue that a symbol is unreferenced. If rendered correctly, you should not feel compelled to "disable" or suppress these.

Here's how it renders in VS Code for comparison. There is no "underline squiggle" or other indication that there is a diagnostic presented on that line because a "tagged hint" isn't meant to be a real diagnostic.

For a full history of this discussion, refer to this thread.