luau-lang/rfcs
1
0
Fork 0
mirror of https://github.com/luau-lang/rfcs.git synced 2025-05-04 10:43:48 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add example for properties

Browse source
This commit is contained in:
Aviral Goel 2024-08-06 10:42:19 -07:00
parent ef386723f2
commit a8b089cd6a
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/syntax-attribute-functions-deprecated.md
View file

@ -15,7 +15,7 @@ This RFC proposes the introduction of a `@deprecated` attribute to mark deprecat
## Design
The `@deprecated` attribute can only be used on named functions and methods. It does not apply recursively to the functions defined within the lexical scope of the attributed function. It can take up to two named string parameters. The parameters affect the warning message issued by the linter. The `reason` parameter gives the reason for deprecation and the `use` parameter gives the name of the function that should be used in lieu of the deprecated function. The following table shows the warning message issued by the different styles of this attribute when used on a function named `foo`.
The `@deprecated` attribute can be used on named functions and properties. It does not apply recursively to the functions defined within the lexical scope of the attributed function. It can take up to two named string parameters. The parameters affect the warning message issued by the linter. The `reason` parameter gives the reason for deprecation and the `use` parameter gives the name of the function that should be used in lieu of the deprecated function. The following table shows the warning message issued by the different styles of this attribute when used on a function named `foo`.
| Style | Message |
| ----------------------------------------------------- | -----------------------------------------------------------------------|
@ -48,6 +48,15 @@ The call to `printTable` causes the linter to issue the following warning messag
Function `printTable` is deprecated, use `table.foreach(table, print)` instead. `printTable` forces tables to be printed in one style; `table.foreach` allows configurable printing.
```
Table and class properties also support deprecated members. In the following example property `m` of table `t` is deprecated.
```lua
local t = {}
@deprecated
function t:m() end
```
## Related Work
Many mainstream languages provide a similar mechanism for deprecating language features. They differ in the kind of program elements that can be deprecated, the ability to convert deprecation warnings to errors, and the ability to specify the version which deprecated the API.