Skip to content

Commit 36d232e

Browse files
committed
Doc - add more docstrings to minecraft API
1 parent e4ccee9 commit 36d232e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

app/server/sonicpi/lib/sonicpi/mods/minecraftpi.rb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -544,7 +544,7 @@ def mc_checkpoint_save
544544
args: [],
545545
opts: nil,
546546
accepts_block: false,
547-
doc: "",
547+
doc: "Take a snapshot of the world and save it. Restore back with `mc_checkpoint_restor`",
548548
examples: [""]
549549

550550

@@ -559,7 +559,7 @@ def mc_checkpoint_restore
559559
args: [],
560560
opts: nil,
561561
accepts_block: false,
562-
doc: "",
562+
doc: "Restore the world to the last snapshot taken with `mc_checkpoint_save`.",
563563
examples: [""]
564564

565565

@@ -574,7 +574,7 @@ def mc_camera_normal
574574
args: [],
575575
opts: nil,
576576
accepts_block: false,
577-
doc: "",
577+
doc: "Set the camera mode to normal.",
578578
examples: [""]
579579

580580

@@ -589,7 +589,7 @@ def mc_camera_third_person
589589
args: [],
590590
opts: nil,
591591
accepts_block: false,
592-
doc: "",
592+
doc: "Set the camera mode to third person",
593593
examples: [""]
594594

595595

@@ -604,7 +604,7 @@ def mc_camera_fixed
604604
args: [],
605605
opts: nil,
606606
accepts_block: false,
607-
doc: "",
607+
doc: "Set the camera mode to fixed.",
608608
examples: [""]
609609

610610

@@ -619,7 +619,7 @@ def mc_camera_set_location(x, y, z)
619619
args: [],
620620
opts: nil,
621621
accepts_block: false,
622-
doc: "",
622+
doc: "Move the camera to a new location.",
623623
examples: [""]
624624

625625

0 commit comments

Comments
 (0)