mirror/zig
1
0
Fork 0
mirror of https://github.com/ziglang/zig.git synced 2026-02-12 20:37:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

@deprecated: add suggested changes to langref entry

Browse Source
This commit is contained in:
Loris Cro 2025-02-23 17:57:28 +01:00 committed by Andrew Kelley
parent 466fa311b1
commit e3da2852f4
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/langref.html.in
View File

@ -4746,19 +4746,18 @@ fn cmpxchgWeakButNotAtomic(comptime T: type, ptr: *T, expected_value: T, new_val
<pre>{#syntax#}@deprecated() void{#endsyntax#}</pre>
<p>
Used to mark a given code path as deprecated. It evaluates to the same value
passed in as argument, or the {#syntax#}void{#endsyntax#} value when given none.
passed in as argument, or the void value when given none.
</p>
<p>
As an example, in Zig 0.14.0 {#syntax#}std.time.sleep{#endsyntax#} was
deprecated and the sleep function was moved to {#syntax#}std.Thread.sleep{#endsyntax#}.
This is how this deprecation could have been expressed:
{#syntax_block|zig|lib/std/time.zig#}
pub const sleep = @deprecated(std.Thread.sleep); // moved
{#end_syntax_block#}
As an example, a library that wishes to move or rename a declaration, while
deprecating usage of the old name can use {#syntax#}@deprecated{#endsyntax#} like so:
</p>
{#syntax_block|zig|root.zig#}
pub const fooToBar = @deprecated(bar.fromFoo); // moved
{#end_syntax_block#}
<p>
By default it is a <b>compile error</b> to depend on deprecated code in
By default it is a <b>compile error</b> to reference deprecated code in
a module defined by the root package, while it is not in modules defined
by dependencies. This behavior can be overridden for the entire dependency
tree by passing {#syntax#}-fallow-deprecated{#endsyntax#} or
@ -4772,9 +4771,9 @@ pub const sleep = @deprecated(std.Thread.sleep); // moved
</p>
<p>
{#syntax#}@deprecated{#endsyntax#} can also be used without argument:
{#code|test_deprecated_builtin.zig#}
Using {#syntax#}@deprecated{#endsyntax#} without an argument can be useful inside of blocks:
</p>
{#code|test_deprecated_builtin.zig#}
{#header_close#}