Docs improvements

crates/bytecode/src/compiler.rs

@@ -34,7 +34,7 @@ enum ErrorKind {
         u16::MAX
     )]
     JumpOffsetIsTooLarge(usize),
-    #[error("Function has too many {property} ({amount})")]
+    #[error("function has too many {property} ({amount})")]
     FunctionPropertyLimit { property: String, amount: usize },
     #[error("missing argument in for loop")]
     MissingArgumentInForLoop,
@@ -64,7 +64,7 @@ enum ErrorKind {
     OutOfPositionMatchEllipsis,
     #[error("root chain node out of position")]
     OutOfPositionRootNodeInChain,
-    #[error("The compiled bytecode is larger than the maximum size of 4GB (size: {0} bytes)")]
+    #[error("the compiled bytecode is larger than the maximum size of 4GB (size: {0} bytes)")]
     ResultingBytecodeIsTooLarge(usize),
     #[error("too many targets in assignment ({0})")]
     TooManyAssignmentTargets(usize),
@@ -79,7 +79,7 @@ enum ErrorKind {
     UnassignedBreakValue,
     #[error("unexpected Ellipsis")]
     UnexpectedEllipsis,
-    #[error("unexpected Wildcard")]
+    #[error("attempting to access an ignored value")]
     UnexpectedWildcard,
     #[error("expected {expected} patterns in match arm, found {unexpected}")]
     UnexpectedMatchPatternCount { expected: usize, unexpected: usize },

crates/bytecode/src/module_loader.rs

@@ -21,9 +21,9 @@ pub enum ModuleLoaderErrorKind {
     Compiler(#[from] CompilerError),
     #[error(transparent)]
     Io(#[from] io::Error),
-    #[error("Failed to get parent of path ('{0}')")]
+    #[error("failed to get parent of path ('{0}')")]
     FailedToGetPathParent(PathBuf),
-    #[error("Unable to find module '{0}'")]
+    #[error("unable to find module '{0}'")]
     UnableToFindModule(String),
 }
 

crates/cli/docs/cli.md

@@ -27,6 +27,7 @@ Welcome to Koto
 » 'hello!'
 ➝ hello!
 ```
+
 ## Help
 
 The [language guide][guide] and the [core library reference][core], 

crates/cli/docs/core_lib/test.md

@@ -107,20 +107,49 @@ assert_near 1 % 0.2, 0.2
 |tests: Map| -> Null
 ```
 
-Runs the tests contained in the map.
+Runs the `@test` functions contained in the map.
+
+`@pre_test` and `@post_test` functions can be implemented in the same way as when exporting
+[module tests](../language_guide.md#module-tests).
+`@pre_test` will be run before each `@test`, and `@post_test` will be run after.
+
 
 ### Example
 
-```koto,skip_check
-my_tests =
-  @pre_test: || self.test_data = 1, 2, 3
-  @post_test: || self.test_data = null
+```koto
+make_x = |n|
+  data: n
+  @+: |other| make_x self.data + other.data
+  @-: |other| make_x self.data - other.data
+
+x_tests =
+  @pre_test: ||
+    self.x1 = make_x 100
+    self.x2 = make_x 200
 
-  @test data_size: || assert_eq self.test_data.size(), 3
-  @test failure: || assert_eq self.test_data.size(), 0
+  @post_test: ||
+    print 'Test complete'
+
+  @test addition: ||
+    print 'Testing addition'
+    assert_eq self.x1 + self.x2, make_x 300
+
+  @test subtraction: ||
+    print 'Testing subtraction'
+    assert_eq self.x1 - self.x2, make_x -100
+
+  @test failing_test: ||
+    print 'About to fail'
+    assert false
 
 try
-  test.run_tests my_tests
-catch error
-  print "An error occurred while running my_tests:\n  {error}"
+  test.run_tests x_tests
+catch _
+  print 'A test failed'
+check! Testing addition
+check! Test complete
+check! Testing subtraction
+check! Test complete
+check! About to fail
+check! A test failed
 ```