Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.

Commit efcc30d

Browse files
committed
[[ CheatSheet ]] Add text explanations of sections
1 parent c18c621 commit efcc30d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/cheat-sheet/cheat-sheet.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
content:
1313
- title: "Comments"
1414
text: |
15+
Comments allow you to add explanations and annotations to your code.
1516
lc: |
1617
-- these
1718
# are
@@ -27,6 +28,7 @@ content:
2728
out */
2829
- title: "Variables"
2930
text: |
31+
Variables are used to to store information, the stored value can be changed or accessed when you need it.
3032
lc: |
3133
local tVar
3234
put "str" into tVar
@@ -48,12 +50,14 @@ content:
4850
arr["key"] = "val";
4951
- title: "Constants"
5052
text: |
53+
Constants store a value that is defined at the point of declaration and never changes.
5154
lc: |
5255
constant kFoo = 15
5356
js: |
5457
const FOO = 15;
5558
- title: "Control Structures"
5659
text: |
60+
Control structures are used to control what code is executed and how many times.
5761
lc: |
5862
repeat for each char tChar in tVar
5963
end repeat
@@ -119,6 +123,7 @@ content:
119123
}
120124
- title: "Operators"
121125
text: |
126+
Operators are ways of combining values such as boolean values, numbers or strings, to produce other values.
122127
lc: |
123128
// Logical
124129
true and false is false
@@ -198,6 +203,7 @@ content:
198203
items[1].charAt(0) == "a"
199204
- title: "String Processing"
200205
text: |
206+
These examples show how string values can be manipulated.
201207
lc: |
202208
// General
203209
put "a" before tVar
@@ -238,6 +244,7 @@ content:
238244
});
239245
- title: "Array Processing"
240246
text: |
247+
These examples show how array values can be manipulated.
241248
lc: |
242249
// Split / combine
243250
put "a,b,c" into tVar
@@ -284,6 +291,7 @@ content:
284291
array.length();
285292
- title: "Sorting"
286293
text: |
294+
These examples show how to sort items and lists.
287295
lc: |
288296
local tList
289297
put "5,2,3,1,4" into tList
@@ -318,6 +326,7 @@ content:
318326
-> data == [[6, 1], [2, 2], [8, 3]]
319327
- title: "Files & Processes"
320328
text: |
329+
These examples show how to read from and write to files and processes.
321330
lc: |
322331
get url("file:/" & tPath)
323332
put "" into url("file:/" & tPath)
@@ -337,6 +346,7 @@ content:
337346
break
338347
- title: "User Input / Notification"
339348
text: |
349+
These examples show how to pop up information dialogs, or prompts for user input.
340350
lc: |
341351
ask "What is your name?"
342352
put it into tName
@@ -357,6 +367,7 @@ content:
357367
alert("Something");
358368
- title: "Custom Handlers"
359369
text: |
370+
A custom handler is a function or command that you define yourself.
360371
lc: |
361372
function foo pParam
362373
end foo
@@ -375,6 +386,7 @@ content:
375386
// foo(value)
376387
- title: "Event Handlers"
377388
text: |
389+
An event handler is a hander that is triggered when an event occurs, such as the use of the mouse or keyboard.
378390
lc: |
379391
// Mouse
380392
on mouseUp pButton

0 commit comments

Comments
 (0)