Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Detect declarations deprecated with a doc comment #2180

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Vexu
Copy link
Contributor

@Vexu Vexu commented Feb 9, 2025

I already get a compile error when using declarations deprecated with @compileError, seeing the ones only deprecated with doc comments is much more useful.

On a related note, why aren't the deprecated identifiers rendered with a strikethrough?

/// Deprecated
const foo = 123;
const bar = @compileError("foo");
comptime {
    foo;
    bar;
}

vs

/**
 * @deprecated test
 */
const foo = 1;
foo

image

Copy link
Member

@Techatrix Techatrix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On a related note, why aren't the deprecated identifiers rendered with a strikethrough?

I believe that VS Code (and possibly other editors) use diagnostics decide whether to render strikethrough symbols using DiagnosticTag::Deprecated. To use semantic tokens, the following change was necessary:

  "editor.semanticTokenColorCustomizations": {
    "rules": {
      "*.deprecated": {
        "strikethrough": true
      }
    }
  }

In the javascript example, you should see a 'foo' is deprecated. message when hovering over foo.


Since ziglang/zig#22822 has been accepted, I am not sure we should support signifying deprecation through comments and instead rely on @deprecated. The DiagnosticTag::Deprecated should be added to error messages if they contain the word "deprecated" at the start or match the output produced by @deprecated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants