feat(practices): add note

EmilySeville7cfg · EmilySeville7cfg · commit b0ac23fdc299 · 2023-05-11T18:05:40.000+10:00
diff --git a/book/style_guide.md b/book/style_guide.md
@@ -1,5 +1,9 @@
 # Best practices
 
+This page lists our best practices we advice to follow. Keep in mind that they are not required to be
+used in external repositories (not ours), you can change them in the way you want,
+but please be consistent and follow your rules.
+
 ## Formatting
 
 ### Defaults
diff --git a/make_docs.nu b/make_docs.nu
@@ -1,6 +1,5 @@
 # remove invalid characters from a path
-#
-# # Examples
+# 
 # using the standard library
 # ```nushell
 # use std.nu
@@ -12,6 +11,7 @@ def safe-path [] {
   $in | str replace --all '\?' '' | str replace --all ' ' '_'
 }
 
+safe-path
 
 # generate the YAML frontmatter of a command
 #

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`# remove invalid characters from a path`
`2`		`-#`
`3`		`-# # Examples`
	`2`	`+#`
`4`	`3`	`# using the standard library`
`5`	`4`	# ```nushell
`6`	`5`	`# use std.nu`
`@@ -12,6 +11,7 @@ def safe-path [] {`
`12`	`11`	`$in \| str replace --all '\?' '' \| str replace --all ' ' '_'`
`13`	`12`	`}`
`14`	`13`
	`14`	`+safe-path`
`15`	`15`
`16`	`16`	`# generate the YAML frontmatter of a command`
`17`	`17`	`#`