Skip to content

Commit 1706826

Browse files
committed
Update documentation for cat to nyan
1 parent 8d9095a commit 1706826

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ Output
7171
Hello, Boi!
7272
```
7373

74-
#### `cat` function
75-
The cat function takes any number of parameters, strings them
74+
#### `nyan` function
75+
The nyan function takes any number of parameters, strings them
7676
together and returns the output so it's available in the
7777
`ret:exit` variable.
7878

@@ -82,8 +82,8 @@ is, well, a calculator.
8282

8383
Conditionals aren't very useful in Boi-lang yet, but here's an example anyway:
8484
```
85-
boi? cat true boi
86-
boi! say "the cat function returned true" boi
85+
boi? nyan true boi
86+
boi! say "the nyan function returned true" boi
8787
BOI
8888
```
8989

demo.boi

+6-6
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ BOI
3131
-- any function. This is done using square brackets as follows:
3232
boi, [returny] boi
3333
boi: tmp [returny] boi
34-
boi, "tmp is: ", boi:tmp boi
34+
boi, "tmp is: " boi:tmp boi
3535

3636
-- next, let's look at some built-in functions
37-
boi, [cat a b c boi:tmp] boi
37+
boi, [nyan a b c boi:tmp] boi
3838

3939
boi: myInteger [int 42] boi
4040
boi, "myInteger as a char: " boi:myInteger boi
@@ -70,16 +70,16 @@ boi, "1 + 2 = " [dec [+ boi:a boi:b]] boi
7070

7171
-- we can access the "exit" value returned by a
7272
-- function using "ret:exit"
73-
boi! cat one two three boi
73+
boi! nyan one two three boi
7474
boi, ret:exit boi
7575

7676
-- conditionals are a thing. The things "true"
7777
-- and "false" are the standard boolean values.
78-
boi? cat true boi
78+
boi? nyan true boi
7979
boi, "this will appear" boi
8080
BOI
8181

82-
boi? cat false boi
82+
boi? nyan false boi
8383
boi, "this will not appear" boi
8484
BOI
8585

@@ -88,7 +88,7 @@ BOI
8888
-- syntax "ONE varname BOI". Note that declaring a
8989
-- variable will explicitly set it to a random value.
9090
ONE CHANGEY BOI
91-
boi? cat true boi
91+
boi? nyan true boi
9292
ONE CHANGEY BOI
9393
boi, "value is " boi:CHANGEY boi
9494
BOI

0 commit comments

Comments
 (0)