luau-lang/luau
1
0
Fork 0
mirror of https://github.com/luau-lang/luau.git synced 2024-12-13 05:20:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
671 commits 7 branches 149 tags 35 MiB
Commit graph

223 commits

Author SHA1 Message Date
JohnnyMorganz
4e5ff99582
Improve Grammar documentation (#315) 2022-01-20 08:27:19 -08:00
dcope-rbx
49ce5096a4
Fixed a couple spelling mistakes in markdown files. (#316) 2022-01-17 09:44:31 -08:00
Halalaluyafail3
497d625f73
Fix some mistakes in the documentation (#314) 2022-01-14 13:42:49 -08:00
Arseny Kapoulkine
b2af550b08
Update grammar.md 
Add forgotten quotes around 'type'; reported by @Dionysusnu
 2022-01-13 15:23:18 -08:00
Arseny Kapoulkine
d6ba106be6
Update compatibility.md 
Add a note about function identity
 2022-01-12 11:56:46 -08:00
T 'Filtered' C
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
Arseny Kapoulkine
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
Arseny Kapoulkine
73b7bcb2da
docs: Move Luau.Web.js fetch to the end of the page 
This was moved in the CodeMirror change, but that may break Module setup in the embedded <script> block, so move it back.
 2022-01-04 15:04:25 -08:00
Arseny Kapoulkine
fa35884e5b
Update library.md 
A few small tweaks and fixes.
 2021-12-27 13:08:56 -08:00
Arseny Kapoulkine
6203bf6ac5
Update grammar.md 
Remove TOC & mark page as wide.
 2021-12-27 12:51:23 -08:00
Arseny Kapoulkine
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
Arseny Kapoulkine
d079201a6e Fix repeated calls to print() clearing output 2021-12-20 15:44:51 -08:00
Arseny Kapoulkine
fedd9a5f78 docs: Fix label syntax 2021-12-20 15:40:38 -08:00
Arseny Kapoulkine
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
Pelanyo Kamara
019eeeb853
Add CodeMirror Editor for Web Demo (#228) 
Also remove timestamps from output
 2021-12-15 09:23:26 -08:00
JohnnyMorganz
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
Lily Brown
864221e667
November 2021 Luau recap (#264) 
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-12-02 13:22:02 -08:00
Arseny Kapoulkine
2aff9bb859
Add documentation for bit32.count* and coroutine.close (#268) 2021-12-02 11:36:40 -08:00
Arseny Kapoulkine
955f9fa754
Update index.md 
Studio => luau-analyze
 2021-11-30 15:26:28 -08:00
vegorov-rbx
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
Arseny Kapoulkine
f185e9f5db
Update performance.md (#252) 
Add documentation for closure allocation elision.
 2021-11-30 08:21:11 -08:00
Tiffany Bennett
a26024fb4b
Use latest release url (#227) 2021-11-22 12:54:27 -08:00
Arseny Kapoulkine
cecd50fb06
Update navigation.yml 
Remove leftover comments
 2021-11-21 20:12:21 -08:00
Arseny Kapoulkine
ffed184562
Update navigation.yml 
Add demo to top-level nav
 2021-11-21 20:12:08 -08:00
Arseny Kapoulkine
2fa5b9c329
Update repl.html 
Try using a release artifact
 2021-11-21 20:07:44 -08:00
ccuser44
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
dcope-rbx
68fb2bdfde
Addressed typecasting documentation feedback (#192) 2021-11-10 11:53:43 -08:00
dcope-rbx
4957812b62
Added documentation related to typecasting (#191) 2021-11-10 09:26:20 -08:00
Pelanyo Kamara
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
Arseny Kapoulkine
46244d2ea7
Update getting-started.md 
Update file extension from .lua to .luau

Contributes to #97
 2021-11-07 23:21:34 -08:00
Arseny Kapoulkine
16753a78f4
Update navigation.yml 
Add GitHub link to top bar
 2021-11-07 08:07:57 -08:00
Arseny Kapoulkine
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
Arseny Kapoulkine
c0b95b8961
Update profile.md 
Too much future.
 2021-11-04 23:24:39 -07:00
Arseny Kapoulkine
adacdcdf4e
Update profile.md 
Remove incorrect sentence copied from the incorrect internal documentation :)
 2021-11-04 18:07:34 -07:00
Arseny Kapoulkine
dc509b9849
Update navigation.yml 
Add profiling page to nav bar
 2021-11-04 17:28:24 -07:00
Arseny Kapoulkine
7c76a5a70a
Create profile.md 
Add profiler documentation.
 2021-11-04 17:27:56 -07:00
Arseny Kapoulkine
e0c4f33217
Add chess-profile.lua 2021-11-04 17:22:04 -07:00
Josh Soref
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
Arseny Kapoulkine
733ae0498d
Update index.md 
Cleanup text and remove extra buttons and redundant links
 2021-11-03 19:10:49 -07:00
Arseny Kapoulkine
06e79462d0
Update index.md 
Remove incorrect text about Luau being Roblox only.
 2021-11-03 14:27:42 -07:00
Arseny Kapoulkine
e34586b847
Update sandbox.md 
Soften the language around Rust
 2021-11-03 12:30:07 -07:00
Arseny Kapoulkine
dc83543f3b
Update 2021-11-03-luau-goes-open-source.md 
Fix links in the announcement
 2021-11-03 10:28:01 -07:00
Arseny Kapoulkine
e997a4cc57
Update index.md 
Fix overlay header - image is not optional :(
 2021-11-03 09:43:20 -07:00
Arseny Kapoulkine
586bef6a4c Add open-source announcement 🎉 2021-11-02 15:50:57 -07:00
Arseny Kapoulkine
dd46710280 Update index.md 
Remove language about Roblox since it suggests the thought that Luau is Roblox specific.
 2021-11-02 15:50:57 -07:00
Arseny Kapoulkine
0ded24c2d5 Switch to releases for build artifacts 2021-11-01 14:52:34 -07:00
Arseny Kapoulkine
650dd30062 Update getting-started and why for open source release 2021-11-01 14:52:34 -07:00
Arseny Kapoulkine
4d168c3543 Add CONTRIBUTING.md and replace README.md 
Also add SVG logo to docs/
 2021-11-01 14:52:34 -07:00
Arseny Kapoulkine
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
vegorov-rbx
e562596bb8
Luau Recap: October 2021 (#92) 
* Draft for October post

* Rebuild pages

* Apply suggestions from code review

Co-authored-by: dcope-rbx <91100513+dcope-rbx@users.noreply.github.com>

* Update 2021-10-31-luau-recap-october-2021.md

Add optimizations

* Remove unfinished section

Co-authored-by: dcope-rbx <91100513+dcope-rbx@users.noreply.github.com>
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-10-29 11:37:43 -07:00
dcope-rbx
c1654e34eb
Fixed doc issue that was unaddressed in a previous code review (#93) 2021-10-29 09:48:58 -07:00
dcope-rbx
1b38e3c8f8
Added syntax documentation for if expressions (#91) 
* Added syntax documentation for if expressions
 2021-10-28 13:44:04 -07:00
Alan Jeffrey
f3a248d1a9
Remove warning about generic functions being disabled (#90) 2021-10-27 11:24:47 -05:00
Arseny Kapoulkine
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
Arseny Kapoulkine
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
Alan Jeffrey
4b02be4e0e
September 2021 Luau Recap (#81) 
* Added the September Luau Recap

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-09-29 15:05:14 -05:00
Arseny Kapoulkine
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
Arseny Kapoulkine
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
vegorov-rbx
c738ddc1f0
Luau Recap: August 2021 (#64) 
* August post is ready

* Fixes

* Rebuild pages

* Apply suggestions from code review

Co-authored-by: Alan Jeffrey <403333+asajeffrey@users.noreply.github.com>

* Update docs/_posts/2021-08-31-luau-recap-august-2021.md

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Fix typo

* Mention additional optimizations

* Fix link

Co-authored-by: Alan Jeffrey <403333+asajeffrey@users.noreply.github.com>
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-08-31 22:16:33 +03:00
Arseny Kapoulkine
ad436994ba
Update performance.md (#65) 
Call out table capacity prediction
 2021-08-31 07:28:49 -07:00
Arseny Kapoulkine
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
Arseny Kapoulkine
81cddbd82c
Update lint.md (#58) 
Add documentation for DuplicateLocal
 2021-08-04 15:24:25 -07:00
Matthew Pagan
9cc9934370
fix: change variable asserted in documentation (#60) 2021-08-04 09:25:01 -07:00
vegorov-rbx
e9db7cd1dc
Luau Recap: July 2021 (#59) 
* July post is ready

* Trigger a build

* Trigger a build

* Added a paragraph for 'DuplicateConditions' lint

* Apply suggestions from code review

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Fix mixed tabs and spaces

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-07-30 19:52:21 +03:00
Arseny Kapoulkine
1f548d4753
Update lint.md (#54) 
Add documentation for the upcoming DuplicateCondition lint
 2021-07-21 16:13:04 -07:00
vegorov-rbx
01d9f8daf9
Luau Recap: June 2021 (#53) 
* Template for the June post

* June post is ready

* Fixed post date

* Added a few examples

* Add another equality operator

* Update docs/_posts/2021-06-30-luau-recap-june-2021.md

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Note the limitation of current constraint resolver

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-07-07 19:45:01 +03:00
Arseny Kapoulkine
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
Arseny Kapoulkine
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
Arseny Kapoulkine
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
Arseny Kapoulkine
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
Arseny Kapoulkine
0fdf8824f1
Update performance.md (#50) 
Add a section about vectors and libraries
 2021-06-11 14:10:55 -07:00
Arseny Kapoulkine
50c22abae0
Update syntax.md (#46) 
Add documentation for named arguments in function types.
 2021-06-02 13:19:46 -07:00
Arseny Kapoulkine
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
Arseny Kapoulkine
b490373454
Update syntax.md (#45) 
Add information about type ascription syntax
 2021-06-02 12:14:24 -07:00
vegorov-rbx
2a29ba1538
Update 2021-05-31-luau-recap-may-2021.md 2021-06-02 19:50:57 +03:00
vegorov-rbx
5c7a981866
Luau Recap: May 2021 (#42) 
* Added May 2021 recap post

* Added missing items and fixed confusing function declaration example

* Apply suggestions from code review

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Small fix

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-06-02 13:19:15 +03:00
Arseny Kapoulkine
fff104b439
Rename linting pass to match internal changes 
The name is cleaner and more correct
 2021-05-30 11:55:52 -07:00
Andy Friesen
fc4cfede58
Document how to actually use an exported type from another module. (#40) 2021-05-28 10:31:47 -07:00
Arseny Kapoulkine
b2b0c33b5e Update CNAME 2021-05-27 19:00:09 -07:00
Arseny Kapoulkine
a4fe638b17 Create CNAME 2021-05-27 18:52:43 -07:00
Arseny Kapoulkine
d6ca8b2ce3 Delete CNAME 2021-05-27 18:33:38 -07:00
Arseny Kapoulkine
d3b551e266 Create CNAME 2021-05-27 18:32:05 -07:00
Arseny Kapoulkine
cbc99c3222
Update syntax.md 
Fix typo: `nunber` -> `number`

Fixes #35.
 2021-05-04 18:57:48 -07:00
vegorov-rbx
b8627707c4
Luau Recap April 2021 (#28) 
* Base for the April post

* Finished April 2021 recap post

* Removed features that are not enabled yet (bye, type-checking section)

* Update docs/_posts/2021-04-30-luau-recap-april-2021.md

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Update docs/_posts/2021-04-30-luau-recap-april-2021.md

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Update docs/_posts/2021-04-30-luau-recap-april-2021.md

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>

* Added 'Coming Soon' for type refinements

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-05-03 23:05:05 +03:00
Arseny Kapoulkine
93fb768a64
Update compatibility.md 
Add a note about os.time
 2021-04-26 14:13:20 -07:00
Arseny Kapoulkine
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
Andy Friesen
bf63d29c9a
Document the duplicate function lint (#26) 2021-04-14 14:29:28 -07:00
canada
149e687d73
Add missing bracket (#25) 2021-04-12 08:44:43 -07:00
Arseny Kapoulkine
51758557e6
Update performance.md 
Correct performance note re: table.insert after a recent update.

Fixes #23.
 2021-04-02 22:37:23 -07:00
Arseny Kapoulkine
094d5a0e09
Update 2021-03-29-luau-recap-march-2021.md 2021-03-31 20:13:19 -07:00
Arseny Kapoulkine
8d712c47b6
Update typecheck.md 2021-03-31 20:12:43 -07:00
Andy Friesen
2d641976ee
Clip references to Array<T> (#21) 
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-03-31 14:24:44 -07:00
Alan Jeffrey
0ab29a02e2
Add Atom feed (#22) 2021-03-31 14:24:26 -07:00
Alan Jeffrey
0b6977554b
Added section on generic functions (#20) 2021-03-31 12:53:21 -07:00
Alan Jeffrey
73b34e15c0
Luau Recap March 2021 (#19) 
Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-03-30 16:45:51 -07:00
ccuser44
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
Max
ed845e6924
Less ambiguity to what 'SECRET TOOL' is? (#18) 
Remove information about internal tooling altogether

Co-authored-by: Arseny Kapoulkine <arseny.kapoulkine@gmail.com>
 2021-03-30 15:53:31 -07:00
Lily Brown
a124f53628
Document variadic types (#17) 2021-03-26 16:07:34 -07:00
Alexander McCord
5f49e3fd95
Add missing docs for multiple returns. (#16) 2021-03-23 12:58:16 -07:00
Arseny Kapoulkine
98494e7ee8 Replace logo and add it as a favicon & actual logo 
Thanks to Brad Sharp for the design.
 2021-03-16 20:30:31 -07:00