docs(tour) comment Chapter func

b353f75e · Brian Tiger Chow · b2323afe · b353f75e
Commit b353f75e authored 10 years ago by Brian Tiger Chow
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 0 deletions

tour/all.go tour/all.go +6 -0

No files found.
--- a/tour/all.go
+++ b/tour/all.go
@@ -94,6 +94,12 @@ var FileBasicsMounting = Content{
 	`,
 }

+// Chapter is used to define a chapter once and derive IDs for any number of
+// sections within.
+//
+// eg.
+// 		Intro := Chapter(1)
+// 		ID("1.1") == Intro(1)
 func Chapter(number int) func(topic int) ID {
 	return func(topic int) ID {
 		return ID(fmt.Sprintf("%d.%d", number, topic))