12c5502027
Update performance.md
...
Update compiler performance metrics to account for O2 and expanding internal codebase
2022-07-22 10:35:03 -07:00
9be7f85be7
Update performance.md ( #608 )
...
Mention constant folding for builtins and remove the note about possibly doing inlining in the future because we do do it now!
2022-07-22 07:53:16 -07:00
96316c66dc
Documentation of round tie-breaking ( #602 )
...
* Update library.md
* Tie-breaking documentation for round
2022-07-18 12:36:23 -07:00
6ad8239e32
Improve description of bit32.extract/replace. ( #585 )
...
Fix description incorrectly saying that parameter w specifies an upper range. w is actually a width. Proof:
print(bit32.extract(2^32-1, 3, 4)) -- prints 15, not 1.
Also indicate that the position is 0-based, and that the function will error if the selected range exceeds the allowed bounds.
2022-07-08 10:06:25 -07:00
a7ae439b0f
Document new table type features ( #567 )
2022-07-05 16:25:09 -05:00
6467c855e8
Update compatibility.md ( #566 )
...
Update `__len` metamethod (pending the code change that implements this)
2022-06-30 17:07:56 -07:00
fc763650d3
Fix broken link in typecheck.md ( #568 )
...
Current link redirects to
https://luau-lang.org/typecheck#Roblox-types (notice the fragment)
which is effectively the same as https://luau-lang.org/typecheck
What the link *wants* to redirect to is
https://luau-lang.org/typecheck#roblox-types (notice the change in fragment)
which is the Roblox types segment of the document
2022-06-30 15:14:49 -07:00
ee82f1e997
Update sandbox.md
...
Since we don't have a formal proof, clarify that we don't have known bugs.
2022-06-28 23:13:13 -07:00
13e50a9cac
Update library.md ( #564 )
...
Clarify behavior of shifts for out of range values.
2022-06-27 09:05:50 -07:00
e91d80ee25
Update compatibility.md ( #559 )
2022-06-23 18:56:19 -07:00
ca32d1bf9d
Update library.md ( #555 )
...
Fix string.match and string.find type definitions
2022-06-22 09:27:05 -07:00
ce9f4e23ae
Update performance.md ( #553 )
...
Document function inlining and loop unrolling.
2022-06-21 13:14:30 -07:00
10ed02470c
Update compatibility.md
...
Add a note on light C functions that Lua 5.2 added; suggested by #512 .
2022-06-01 14:19:17 -04:00
70ff6b4347
Update performance.md ( #494 )
...
Add a section on table length optimizations and reword the table iteration section a bit to account for generalized iteration.
2022-05-20 13:00:53 -07:00
f3f231ea6b
Update compatibility.md
...
Update `__pairs` note with `__iter`, change `__len` to unsure as with `__iter` lack of `__len` on tables is the only issue preventing complete user created containers.
2022-05-09 18:38:10 -07:00
be0b7d07e2
Update sandbox.md
...
Replace debug.getinfo with debug.info
2022-05-09 18:34:31 -07:00
7935f9f8b6
Update sandbox.md
...
Reword the GC docs to avoid back-referencing the thread identity mechanism, since it's entirely Roblox-side and isn't fully documented here anymore.
2022-05-09 18:33:53 -07:00
72d8d44343
Add documentation for generalized iteration ( #475 )
2022-05-05 17:05:57 -07:00
ffff25a9e5
Improve the UX of reading tagged unions a smidge. ( #449 )
...
The page is a little narrow, and having to scroll on this horizontally isn't too nice. This fixes the UX for this specific part.
2022-04-07 09:16:44 -07:00
dc32a3253e
Add short example of width subtyping ( #444 )
2022-03-31 18:44:41 -05:00
ba60730e0f
Add documentation on singleton types and tagged unions to typecheck.md. ( #440 )
...
Update the typecheck.md page to talk about singleton types and their uses, tagged unions.
As a driveby, improve the documentation on type refinements. And delete the unknown symbols part, this is really dated.
* Update docs/_pages/typecheck.md to fix a typo
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2022-03-31 11:54:06 -07:00
2335b26ffc
Update library.md
...
Add documentation for table.clone
2022-03-24 09:31:18 -07:00
fe71aff7af
Update library.md
2022-03-14 10:30:49 -07:00
1334db600f
Update grammar.md ( #379 )
2022-02-22 11:24:15 -08:00
6aaaafcc8d
Add documentation for upcoming CommentDirective lint ( #361 )
2022-02-17 16:58:43 -08:00
aecd60371b
Update performance.md ( #355 )
...
Document weak table shrinking and paged sweeper
2022-02-11 09:13:27 -08:00
abe3f87b48
docs: Add documentation for upcoming MisleadingAndOr lint ( #349 )
...
This is going to be part of Luau 0.514
2022-02-09 09:27:01 -08:00
ec481695a3
Update library.md ( #352 )
...
Clarify the relationship between `typeof` and `newproxy`. As a sandboxing measure, `typeof` only uses `__type` on host-defined userdata.
Fixes #351 .
2022-02-09 09:19:50 -08:00
4e5ff99582
Improve Grammar documentation ( #315 )
2022-01-20 08:27:19 -08:00
49ce5096a4
Fixed a couple spelling mistakes in markdown files. ( #316 )
2022-01-17 09:44:31 -08:00
497d625f73
Fix some mistakes in the documentation ( #314 )
2022-01-14 13:42:49 -08:00
b2af550b08
Update grammar.md
...
Add forgotten quotes around 'type'; reported by @Dionysusnu
2022-01-13 15:23:18 -08:00
d6ba106be6
Update compatibility.md
...
Add a note about function identity
2022-01-12 11:56:46 -08:00
abf9fc2754
Update compatibility.md to split coroutine.close from lua_resetthread ( #309 )
...
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2022-01-12 11:50:25 -08:00
b7a7b92d12
Update syntax.md
...
Remove confusing block because it reads as if we *do* support this syntax if you aren't reading carefully.
2022-01-11 13:24:56 -08:00
fa35884e5b
Update library.md
...
A few small tweaks and fixes.
2021-12-27 13:08:56 -08:00
6203bf6ac5
Update grammar.md
...
Remove TOC & mark page as wide.
2021-12-27 12:51:23 -08:00
65177c425c
Update grammar.md
...
This changes the grammar to follow the EBNF rules more rigorously, most significantly quoting all keywords.
2021-12-27 12:48:58 -08:00
9e7e779c02
Quality of life improvements to web demo ( #297 )
...
- Upgrade CodeMirror to 5.65
- Enable matching paren highlighting via an addon
- Remove extra buttons and replace clear output with a checkbox
- Highlight error line on parsing/execution error
- Change demo layout to wide to increase available width
2021-12-20 15:36:41 -08:00
2e6a2090c3
Add Grammar documentation ( #266 )
...
Co-authored-by: Alexander McCord <11488393+alexmccord@users.noreply.github.com>
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-12-08 09:17:28 -08:00
2aff9bb859
Add documentation for bit32.count* and coroutine.close ( #268 )
2021-12-02 11:36:40 -08:00
6801c65090
Documentation for type packs ( #257 )
...
* Documentation for type packs
* Update docs/_pages/typecheck.md
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
* Add a note about the difference between ...T and T...
Fix a typo at the start as well.
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-11-30 14:00:23 -08:00
f185e9f5db
Update performance.md ( #252 )
...
Add documentation for closure allocation elision.
2021-11-30 08:21:11 -08:00
a02086260b
Added note to docs about not using os.difftime for new work ( #210 )
...
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
Fixes #194 .
2021-11-17 06:42:04 -08:00
68fb2bdfde
Addressed typecasting documentation feedback ( #192 )
2021-11-10 11:53:43 -08:00
4957812b62
Added documentation related to typecasting ( #191 )
2021-11-10 09:26:20 -08:00
aec8fbfd0f
Feature: Web REPL using Emscripten ( #138 )
...
Currently doesn't include the new page into navigation since we aren't building the .js files anywhere.
2021-11-10 08:40:46 -08:00
46244d2ea7
Update getting-started.md
...
Update file extension from .lua to .luau
Contributes to #97
2021-11-07 23:21:34 -08:00
c6de3bd2e4
Update sandbox.md
...
Remove section on thread identity: this is not part of open-source Luau and as such is now confusing.
2021-11-05 19:50:29 -07:00
c0b95b8961
Update profile.md
...
Too much future.
2021-11-04 23:24:39 -07:00
adacdcdf4e
Update profile.md
...
Remove incorrect sentence copied from the incorrect internal documentation :)
2021-11-04 18:07:34 -07:00
7c76a5a70a
Create profile.md
...
Add profiler documentation.
2021-11-04 17:27:56 -07:00
278e848cc2
Spelling ( #119 )
...
Fixed various spelling errors.
Co-authored-by: Josh Soref <jsoref@users.noreply.github.com>
2021-11-04 09:50:46 -05:00
e34586b847
Update sandbox.md
...
Soften the language around Rust
2021-11-03 12:30:07 -07:00
0ded24c2d5
Switch to releases for build artifacts
2021-11-01 14:52:34 -07:00
650dd30062
Update getting-started and why for open source release
2021-11-01 14:52:34 -07:00
33cb9d5991
Update performance.md ( #94 )
...
Add documentation on shorter atomic pauses
Co-authored-by: vegorov-rbx <75688451+vegorov-rbx@users.noreply.github.com>
2021-11-01 12:08:01 -07:00
c1654e34eb
Fixed doc issue that was unaddressed in a previous code review ( #93 )
2021-10-29 09:48:58 -07:00
1b38e3c8f8
Added syntax documentation for if expressions ( #91 )
...
* Added syntax documentation for if expressions
2021-10-28 13:44:04 -07:00
f3a248d1a9
Remove warning about generic functions being disabled ( #90 )
2021-10-27 11:24:47 -05:00
2341b5014e
Update compatibility.md
...
Given the new RFC we clearly don't think coroutine.close is never going to happen :)
2021-10-26 17:19:37 -07:00
1ec7be600c
docs: Create library.md ( #87 )
...
Full documentation for the standard library, written from scratch by looking at the source code - so hopefully this is reasonably correct/precise.
Some of the function descriptions are probably too concise to be easily understandable - we can flesh this out in the future.
Some of the type specifications aren't using valid Luau syntax; in particular, I've used "function" or "table" in a few places as a human-friendly notion that any function/table suffices, and the iterator functions just say that they return <iterator> without being specific as to what the signature of the generator is.
2021-10-19 13:54:44 -07:00
ae1c104fd1
Update performance.md ( #71 )
...
Add some information about the new GC pacer
Co-authored-by: Alan Jeffrey <403333+asajeffrey@users.noreply.github.com>
2021-09-15 16:19:45 -07:00
4e6ca2531b
Update performance.md ( #69 )
...
Remove placeholder sections for performance optimizations - we'll just add individual optimizations to this document as we deploy them.
2021-09-15 16:07:16 -07:00
ad436994ba
Update performance.md ( #65 )
...
Call out table capacity prediction
2021-08-31 07:28:49 -07:00
bb8870a1d4
Update compatibility.md ( #63 )
...
Add a note about `pcall` - really the C limit is universal but it will most often be hit during either pcall or coroutine.resume.
2021-08-30 10:31:52 -07:00
81cddbd82c
Update lint.md ( #58 )
...
Add documentation for DuplicateLocal
2021-08-04 15:24:25 -07:00
9cc9934370
fix: change variable asserted in documentation ( #60 )
2021-08-04 09:25:01 -07:00
1f548d4753
Update lint.md ( #54 )
...
Add documentation for the upcoming DuplicateCondition lint
2021-07-21 16:13:04 -07:00
bf17b6447a
Update lint.md ( #52 )
...
* Update lint.md
Add documentation for DeprecatedApi (live) and TableOperations (ships on July 7th)
* Update lint.md
Shorten line a bit
2021-07-06 09:06:51 -07:00
c8af786b10
Update compatibility.md
...
We decided that we can't enforce strict limits for insert/remove based on analysis of Roblox games
2021-06-15 19:05:27 -07:00
b439c9fcdc
Update performance.md
...
Restore the original sentence with tweaks; this seems like better wording since it highlights the importance of knowing the field name at compile time, no matter the notation.
2021-06-14 18:54:47 -07:00
40a175499e
Update performance.md
...
Remove outdated statement about table["field"] since we optimize it now the same way as table.field.
2021-06-14 10:53:26 -07:00
0fdf8824f1
Update performance.md ( #50 )
...
Add a section about vectors and libraries
2021-06-11 14:10:55 -07:00
50c22abae0
Update syntax.md ( #46 )
...
Add documentation for named arguments in function types.
2021-06-02 13:19:46 -07:00
b20601af89
Update lint.md ( #44 )
...
Update FunctionUnused and ImportUnused following internal changes that make it possible to suppress the warning using _
2021-06-02 12:49:35 -07:00
b490373454
Update syntax.md ( #45 )
...
Add information about type ascription syntax
2021-06-02 12:14:24 -07:00
fff104b439
Rename linting pass to match internal changes
...
The name is cleaner and more correct
2021-05-30 11:55:52 -07:00
fc4cfede58
Document how to actually use an exported type from another module. ( #40 )
2021-05-28 10:31:47 -07:00
cbc99c3222
Update syntax.md
...
Fix typo: `nunber` -> `number`
Fixes #35 .
2021-05-04 18:57:48 -07:00
93fb768a64
Update compatibility.md
...
Add a note about os.time
2021-04-26 14:13:20 -07:00
258966863c
Update compatibility.md ( #27 )
...
Call out the upcoming change to `print` and slightly reword a couple of rows. Also add a list of differences from 5.x that was previously requested (the list is likely incomplete)
2021-04-21 10:42:27 -07:00
bf63d29c9a
Document the duplicate function lint ( #26 )
2021-04-14 14:29:28 -07:00
149e687d73
Add missing bracket ( #25 )
2021-04-12 08:44:43 -07:00
51758557e6
Update performance.md
...
Correct performance note re: table.insert after a recent update.
Fixes #23 .
2021-04-02 22:37:23 -07:00
8d712c47b6
Update typecheck.md
2021-03-31 20:12:43 -07:00
2d641976ee
Clip references to Array<T> ( #21 )
...
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-03-31 14:24:44 -07:00
0b6977554b
Added section on generic functions ( #20 )
2021-03-31 12:53:21 -07:00
e051e33482
Removed incorrect info ( #14 )
...
* Removed incorrect info
The manual says Luau does not support hexadecimal \0x, Unicode \u and \z
when this clearly isn't the case.
This is also quite confusing as just a bit below it says it does support them.
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-03-30 15:54:58 -07:00
a124f53628
Document variadic types ( #17 )
2021-03-26 16:07:34 -07:00
5f49e3fd95
Add missing docs for multiple returns. ( #16 )
2021-03-23 12:58:16 -07:00
ab913e5bc5
Update compatibility page
...
This brings the page in line with other pages by adding TOC, removing duplicate header and moving it to the correct location in the tree.
2021-03-15 21:56:18 -07:00
710547df83
Fix paranthesis ( #13 )
2021-03-14 16:29:46 -07:00
6c709f8e65
Added News section ( #12 )
...
* Add outline News section
* First draft Feb 2021 Recap
* Fixed image links
* Removed type definition files and refinements
* Added Luau Type Checking Release
* Added Luau Type Checking Beta
* Added Luau Recap August 2020
* Added Luau Recap June 2020
* Fixed code typos
* Formatting
* Removed mention of class declarations
* Rename 2020-06-20-luar-recap-june-2020.md to 2020-06-20-luau-recap-june-2020.md
* Add luau-recap-feb2021-benchmark.png
* Add luau-recap-february-2021-benchmark.png
* Delete luau-recap-feb2021-benchmark.png
* Added some more miscellaneous improvements
* Update 2021-03-01-luau-recap-february-2021.md
Expand on perf. improvements and mention table.clear.
* Update 2021-03-01-luau-recap-february-2021.md
* Update 2021-03-01-luau-recap-february-2021.md
* Removed the navigation link to Home as it didn't fit on mobile
* Removed unneeded file
* Added Luau Recap May 2020
* Added Debugger improvements
* Added Luau Recap Feb 2020
* Added Luau Recap Nov 2019
* Added a debugger screenshot
* Added image assets
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
2021-03-02 12:45:21 -08:00
d04a41fcff
Change to minimal-mistakes theme ( #11 )
...
Use minimal-mistakes theme. Add a splash front page and a getting started page.
2021-02-12 12:26:08 -08:00
Arseny Kapoulkine