google / google/xls

Add `#[deprecated]` attribute

Open
#1,348 1 comment 0 reactions 0 assignees View on GitHub
dslx enhancement
Dominant language
C++
Stars
1.9k
Forks
283
Avg merge
2d 10h
Merged PRs (30d)
135

Description

Deprecation attributes are kind of interesting, because you might _think_ they should flag a warning. But then for anybody who does warnings-as-errors (as we do), deprecating something in a way that causes an error would mean you have to delete it right away!

So you kind of figure deprecation warnings must be more like "notices". However, it seems like, in reality, they only show up in code search indices and maybe language server clients, e.g. as struck out identifiers to make for a helpful indicator.

So there's no deprecation "warnings" in that case, just kind of helpful strikethroughs in IDEs.

In any case, we should be able to mark an item as deprecated, though we then (I expect) will not produce warnings when it is used.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.