Skip to content

Commit 1843eb8

Browse files
author
Monte Goulding
committed
[[ Bug ]] Fix documentation examples that don't compile
1 parent d38ae2d commit 1843eb8

File tree

116 files changed

+577
-203
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

116 files changed

+577
-203
lines changed

‎docs/dictionary/command/cut.lcdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Example:
1616
cut -- cuts whatever is selected
1717

1818
Example:
19-
cut player "Quivering Apple" from recent card
19+
cut player "Quivering Apple" of recent card
2020

2121
Example:
2222
cut the selectedObject

‎docs/dictionary/command/decrypt-using-rsa.lcdoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ Platforms: desktop,server,web,mobile
1515
Security: network
1616

1717
Example:
18-
decrypt tMessage with public key tPublicKey
18+
decrypt tMessage using rsa with public key tPublicKey
1919

2020
Example:
21-
decrypt field 1 with private key tPrivateKey
21+
decrypt field 1 using rsa with private key tPrivateKey
2222

2323
Parameters:
2424
source:

‎docs/dictionary/command/do.lcdoc‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,11 @@ Example:
2020
do "go next card"
2121

2222
Example:
23-
do "put" x "into tNumberOfRecords" x -- might become "put 3 into tNumberOfRecords"
23+
do "put" x "into tNumberOfRecords"
24+
-- might become "put 3 into tNumberOfRecords"
2425

2526
Example:
26-
do "select" line 3 of field "Objects"
27+
do "select" && line 3 of field "Objects"
2728

2829
Example:
2930
do field "Statements" as AppleScript

‎docs/dictionary/command/encrypt-using-rsa.lcdoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ Platforms: desktop,server,web,mobile
1515
Security: network
1616

1717
Example:
18-
encrypt myMessage with public key myKey
18+
encrypt myMessage using rsa with public key myKey
1919

2020
Example:
21-
encrypt thisMessage with private key privateKey
21+
encrypt thisMessage using rsa with private key privateKey
2222

2323
Parameters:
2424
source:

‎docs/dictionary/command/encrypt.lcdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ then copies the file back to disk. */
4242
local path2input, myData, path2output
4343
/* put the file path to your input and output files into path2input and path2output */
4444
put URL ("binfile:" & path2input) into myData
45-
encrypt myData using "aes-256-cbc" with password “@&^2fy”
45+
encrypt myData using "aes-256-cbc" with password "@&^2fy"
4646
put it into URL ("binfile:" & path2output)
4747

4848
Description:

‎docs/dictionary/command/export-snapshot.lcdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Summary: Creates a picture file from a portion of the screen.
1111
Introduced: 2.1
1212

1313
Example:
14-
export snapshot with effects to file "Test.ppm"
14+
export snapshot to file "Test.ppm"
1515

1616
Example:
1717
export snapshot from rect "0,0,200,200" to file "Nav.jpg" as JPEG

‎docs/dictionary/command/go.lcdoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ Name: go
22

33
Type: command
44

5-
Syntax: go [invisible] [to] <card> [of <stack>] [as <mode> |in [a] new window|in <window>]
5+
Syntax: go [invisible] [to] <card> [of <stack>] [{as <mode> |in [a] new window|in <window>}]
66

77
Syntax: go [invisible] [to] {first | prev[ious]| next | last | any} [marked] [<card>]
88

99
Syntax: go [invisible] [to] {recent | start | finish | home} <card>
1010

11-
Syntax: go {forward | forth | back[ward]} [<number>]}
11+
Syntax: go {forward | forth | back[ward]} [<number>]
1212

1313
Summary: Navigates to another <card> or <stack>.
1414

‎docs/dictionary/command/intersect.lcdoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ intersect tLeft with tRight recursively
4343
# tRight unchanged
4444

4545
Example:
46-
function ScriptIntersect(pLeft, pRight, pRecursive)
46+
function ScriptIntersect pLeft, pRight, pRecursive
4747
repeat for each key tKey in pLeft
4848
if tKey is not among the keys of pRight then
4949
delete variable pLeft[tKey]
@@ -55,7 +55,7 @@ function ScriptIntersect(pLeft, pRight, pRecursive)
5555
return pLeft
5656
end ScriptIntersect
5757

58-
function EngineIntersect(pLeft, pRight, pRecursive)
58+
function EngineIntersect pLeft, pRight, pRecursive
5959
if pRecursive then
6060
intersect pLeft with pRight recursively
6161
else
@@ -66,7 +66,7 @@ function EngineIntersect(pLeft, pRight, pRecursive)
6666
end EngineIntersect
6767

6868
-- This function should return true for all inputs.
69-
function CheckIntersect(pLeft, pRight, pRecursive)
69+
function CheckIntersect pLeft, pRight, pRecursive
7070
return ScriptIntersect(pLeft, pRight, pRecursive) is EngineIntersect(pLeft, pRight, pRecursive)
7171
end CheckIntersect
7272

‎docs/dictionary/command/move.lcdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ OS: mac,windows,linux,ios,android
1313
Platforms: desktop,server,web,mobile
1414

1515
Example:
16-
move image "sprite" to the mouseLocation in 30 ticks
16+
move image "sprite" to the mouseLoc in 30 ticks
1717

1818
Example:
1919
move button ID 4 relative 50,50 without waiting

‎docs/dictionary/command/open-file.lcdoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Example:
2121
open file "/etc/Glossary" for write
2222

2323
Example:
24-
open file (myFilePath "/" myFileName) for binary read
24+
open file (myFilePath & "/" & myFileName) for binary read
2525

2626
Parameters:
2727
filePath: Specifies the name and location of the file you want to open or create. If you specify a name but not a location, LiveCode assumes the file is in the defaultFolder. If the file you specify doesn't exist, LiveCode creates it.

0 commit comments

Comments
 (0)