mirrors/luau
1
0
Fork 0
mirror of https://github.com/luau-lang/luau.git synced 2024-11-15 22:35:43 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
774 Commits 9 Branches 146 Tags 40 MiB
a0fe195305
Commit Graph

225 Commits

Author SHA1 Message Date
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
Arseny Kapoulkine
0802697a87
Update navigation.yml 
Add compatibility link
 2021-03-15 21:56:50 -07:00
Arseny Kapoulkine
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
tacheometry
710547df83
Fix paranthesis (#13) 2021-03-14 16:29:46 -07:00
Alan Jeffrey
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
AtomicOperation
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
Kyle
41564d281c
docs: fix minor typos (#8) 2021-01-27 19:26:39 -08:00
Arseny Kapoulkine
44cdeb07cc
Update lint.md 
Add DeadLocal warning description
 2021-01-27 17:34:20 -08:00
Alexander
93f9e5e824
Minor improvements in type checking docs (#9) 
It was somewhat outdated from the current Luau world. Some changes to fix that problem.

1. Global assignments are now allowed in nonstrict mode.
2. The example that assigns to `x` from the argument `y` in the function `f` was needlessly complicated. I elected to delete it.
3. Require tracing docs shouldn't need to explain the three possible outcomes.
 2021-01-20 11:07:04 -08:00
Arseny Kapoulkine
5e069fa04a
Update limited-terms-of-use.md 2020-12-14 23:22:56 -08:00
Arseny Kapoulkine
83d6132e1d
Update limited-terms-of-use.md 2020-12-14 16:34:01 -08:00
rblanckaert
8f5ab4c47c
Create limited-terms-of-use.md (#7) 2020-12-07 12:01:37 -08:00
Arseny Kapoulkine
ffa3c9fe7a
Update index.md (#6) 
Add casing and pronunciation guide
 2020-12-02 15:57:25 -08:00
Arseny Kapoulkine
43fed897c1
Update typecheck.md 2020-11-02 12:06:08 -08:00
Arseny Kapoulkine
9d4f338473
Update syntax.md 
Add short-hand array like table syntax.
 2020-10-20 17:47:48 -07:00
Arseny Kapoulkine
ad9f2ac5d0
Update typecheck.md 
Add short hand array like type syntax
 2020-10-20 17:46:29 -07:00
Arseny Kapoulkine
98402c3798
Update performance.md 2020-10-07 12:07:13 -07:00
Arseny Kapoulkine
7480d62ba9
Update typecheck.md 
Tweak Roblox types section a tiny bit
 2020-09-30 11:25:18 -07:00
Alexander
8e38c0ec7d
Fix function type annotation grammar in docs. (#5) 2020-08-11 16:56:07 -07:00
Arseny Kapoulkine
3be82035bf
Update lint.md (#4) 
Add TableLiteral docs
 2020-08-05 16:56:59 -07:00
Arseny Kapoulkine
a0cd6aa160
Update index.md 2020-08-05 16:07:44 -07:00
Arseny Kapoulkine
a78be01124
Update why.md 
Tiny spelling fix
 2020-08-05 16:06:26 -07:00
Arseny Kapoulkine
637e171a9b
Update lint.md (#3) 
Document new FormatString lint
 2020-07-31 20:55:35 -07:00
Arseny Kapoulkine
ac53e4efc0
Update compatibility.md (#2) 
This reflects the code changes we've made to upgrade string library:

- Updated the match implementation to 5.2, adding support for `%g` and `\0` in patterns
- Added string pack/unpack from 5.3
 2020-07-24 11:10:59 -07:00
Arseny Kapoulkine
6163ac78b5
Update performance.md 
Add a section about upvalue optimizations.
 2020-06-29 09:42:18 -07:00
Arseny Kapoulkine
c4148cea83
Update index.md 2020-06-25 18:11:49 -07:00
Arseny Kapoulkine
9ca9cc8f7c
Add _layouts/default.html 
The repository is currently private and there doesn't seem to be a different way to hide the link to it.
 2020-06-24 13:14:15 -07:00
Arseny Kapoulkine
053061e3e8
Update syntax.md 
Fix hexadecimal escape sequences
 2020-06-24 12:20:58 -07:00
Arseny Kapoulkine
2cd63aa589
Update typecheck.md 
Wording changes in unknown symbols
 2020-06-23 09:36:57 -07:00
Arseny Kapoulkine
9939c5c361
Update performance.md 2020-06-22 16:28:16 -07:00
Alexander McCord
af24404615 fix broken link 2020-06-19 00:06:05 -07:00
Alexander McCord
149c14f115 Minor wording changes to typecheck.md 2020-06-18 23:55:19 -07:00
Alexander McCord
aac31bdc1f Add unknown symbols to typecheck.md 2020-06-18 23:36:14 -07:00
Alexander McCord
593285c012 Add typing idiomatic OOP section 2020-06-18 21:57:55 -07:00
Alexander McCord
e3a161e950 Add Modules interactions section to typecheck.md 2020-06-18 18:51:51 -07:00
Arseny Kapoulkine
68264852a9
Update typecheck.md (#1) 2020-06-18 18:43:38 -07:00
Alexander McCord
876b2ad644 docs: Update typechecking.md 2020-06-18 16:23:23 -07:00
Arseny Kapoulkine
7252cbdede
Update sandbox.md 
Exclude debug.getinfo for now as we haven't enabled it yet for Roblox
 2020-06-18 11:18:18 -07:00
Alexander McCord
2e6354f4a7 docs: demote empty statements to shrug 2020-06-12 09:55:16 -07:00
Arseny Kapoulkine
3eec4437d2 docs: Wording 2020-06-12 08:07:35 -07:00
Arseny Kapoulkine
479189107f docs: Hopefully final tweak 2020-06-12 02:43:40 -07:00
Arseny Kapoulkine
71b40ba34e docs: Cleanup compiler wording 2020-06-12 02:40:28 -07:00
Arseny Kapoulkine
2d07039efd docs: Amend goals 2020-06-12 02:31:33 -07:00
Arseny Kapoulkine
064623aa4d docs: Finish performance section 
Still missing details on Vector3 and GC but both of these are in
development so aren't ready to be documented anyway.
 2020-06-12 02:29:30 -07:00
Arseny Kapoulkine
c8007a73b8 docs: Add a couple perf notes 2020-06-12 01:48:10 -07:00
Arseny Kapoulkine
754f202f78 docs: Start fleshing out performance section 
There's still more to document here.
 2020-06-12 01:44:56 -07:00
Arseny Kapoulkine
a56260d3f0 docs: Add interrupts info 2020-06-12 01:01:33 -07:00
Arseny Kapoulkine
d64896a324 docs: Add open source note as the Q comes up. 2020-06-12 00:34:56 -07:00
Arseny Kapoulkine
fdfd94dd00 docs: Finish sandboxing section 
Also add a note about ephemeron tables to compatibility.
 2020-06-12 00:28:39 -07:00
Arseny Kapoulkine
b5c00ec43a docs: Sidebar styling fix 2020-06-11 23:40:39 -07:00
Arseny Kapoulkine
c350af1be5 docs: Update sidebar nav 2020-06-11 23:39:27 -07:00
Arseny Kapoulkine
34a1340d94 docs: Experimenting with sidebar nav 2020-06-11 23:36:25 -07:00
Arseny Kapoulkine
df18cb5193 docs: Use h1/h2 styling 
Also start filling out sandbox section
 2020-06-11 23:31:35 -07:00
Arseny Kapoulkine
b771393e71 docs: Add Lua 5.1 to compatibility section 2020-06-11 23:21:30 -07:00
Arseny Kapoulkine
3f6164a94b docs: Add stack nesting information and tail calls 2020-06-11 23:17:06 -07:00
Arseny Kapoulkine
ea494050f3 docs: Fix spelling 2020-06-11 22:21:17 -07:00
Arseny Kapoulkine
1cd20c92d4 docs: Forgot a lua syntax 2020-06-11 22:19:03 -07:00
Arseny Kapoulkine
0eb36fd40b docs: Add linter docs 
This describes all warnings, including ones that aren't enabled in
Studio by default yet.
 2020-06-11 22:17:38 -07:00
Arseny Kapoulkine
92942a2c54 docs: Document child function limit 2020-06-11 21:19:19 -07:00
Arseny Kapoulkine
35f337d2ce docs: Add stub documents for all links to point somewhere 2020-06-11 20:44:50 -07:00
Arseny Kapoulkine
1c91ca1f2d docs: More emoji tweaks 
Also move \u to Lua 5.3
 2020-06-11 20:35:10 -07:00
Arseny Kapoulkine
6424d84bc3 docs: More emoji tweaks 2020-06-11 20:31:29 -07:00
Arseny Kapoulkine
345e46ee7f docs: Use actual emojis 
Apparently :foo: doesn't work in GH Pages :(
 2020-06-11 20:29:31 -07:00
Arseny Kapoulkine
d1c3499aa4 docs: Add compatibility section 
The table formatting here is likely not great for our layout, which will
be resolved separately.
 2020-06-11 20:25:43 -07:00
Arseny Kapoulkine
742ec27210 docs: Wording 2020-06-11 09:07:17 -07:00
Arseny Kapoulkine
b3aac63429 docs: Cleanup 2020-06-11 08:59:31 -07:00
Arseny Kapoulkine
3be2497c48 docs: Cleanup 2020-06-11 08:51:33 -07:00
Arseny Kapoulkine
8ba5114adf docs: Highlight the fact that extra syntax isn't supported 2020-06-11 08:51:05 -07:00
Arseny Kapoulkine
476fcf0ae7 docs: Add syntax.md 
This should be a full description of the extra syntax we've added to
Luau.
 2020-06-11 08:46:10 -07:00
Arseny Kapoulkine
4cfb03f92e docs: Move most of Motivation into why.md 
Also expand why.md a bit to talk about implementation.
 2020-06-10 17:29:59 -07:00
Arseny Kapoulkine
a89acb853e docs: Add an example, and fix typo 2020-06-10 17:04:33 -07:00
Arseny Kapoulkine
5e9f0e2844 docs: Flesh out index.md 
This has background information and callouts to individual sections that
have yet to be written.
 2020-06-10 16:59:16 -07:00
Arseny Kapoulkine
b02972829f Set theme jekyll-theme-minimal 2020-06-10 16:28:01 -07:00
Arseny Kapoulkine
50232a75e4 docs: Add index.md 2020-06-10 16:23:19 -07:00