luau-lang/luau
1
0
Fork 0
mirror of https://github.com/luau-lang/luau.git synced 2025-04-08 04:40:54 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: Document return value for table.remove (#987)

Browse source 
Fixes #984.
This commit is contained in:
Arseny Kapoulkine 2023-07-26 06:42:23 -07:00 • committed by GitHub
parent 743afe6ec9
commit f80229c517
Signed by: DevComp
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/_pages/library.md
View file

@ -403,11 +403,12 @@ When using a two-argument version, appends the value to the array portion of the
When using a three-argument version, inserts the value at index `i` and shifts values at indices after that by 1. `i` should be in `[1..#t]` range.
```
function table.remove<V>(t: {V}, i: number?)
function table.remove<V>(t: {V}, i: number?): V?
```
Removes element `i` from the table and shifts values at indices after that by 1. If `i` is not specified, removes the last element of the table.
`i` should be in `[1..#t]` range.
Returns the value of the removed element, or `nil` if no element was removed (e.g. table was empty).
```
function table.sort<V>(t: {V}, f: ((V, V) -> boolean)?)