Improve main documentation

1 files changed, 17 insertions, 11 deletions

diff --git a/src/errors.rs b/src/errors.rs
index e98483f..f29d635 100644
--- a/src/errors.rs
+++ b/src/errors.rs
@@ -16,37 +16,43 @@
  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
+//! <!-- TODO figure out module-level docs for this -->
+
+#[cfg(doc)]
+use crate::PatternTypes;
+
 /// These are errors that may be returned by the pattern compiler when
 /// compiling a pattern.
 ///
 /// "String" here refers to a string literal in the pattern, not the input
-/// string. The input string is referred to as "the input".
+/// string. The input string is referred to as "the pattern".
 #[derive(Debug)]
 pub enum PatternError<'a> {
     // Syntax Errors:
 
-    /// The input contains an invalid string escape.
+    /// The pattern contains an invalid string escape.
     StringEscape(usize, &'a str),
-    /// The input ends in the middle of a string literal.
+    /// The pattern ends in the middle of a string literal.
     StringEnd(usize, &'a str),
-    /// The input contains an invalid regex escape.
+    /// The pattern contains an invalid regex escape.
     RegexEscape(usize, &'a str),
-    /// The input ends in the middle of a regex literal.
+    /// The pattern ends in the middle of a regex literal.
     RegexEnd(usize, &'a str),
-    /// The input contains characters that don't make up a token.
+    /// The pattern contains characters that don't make up a token.
     Token(usize, &'a str),
 
     // Link Errors:
 
-    /// The input requests a parameter that wasn't provided.
+    /// The pattern requests a parameter that wasn't provided.
     UnknownParameter(usize, &'a str),
-    /// The input requests a predicate that wasn't provided.
+    /// The pattern requests a predicate that wasn't provided.
     UnknownPredicate(usize, &'a str),
-    /// The input contains an invalid regex.
+    /// The pattern contains an invalid regex.
     Regex(usize, &'a str, ::regex::Error),
 }
 
-/// Error type returned by the matcher.
+/// These are errors that may be returned by the matcher when matching a
+/// pattern.
 #[derive(Clone, Debug)]
 pub enum MatchError {
     /// Returned if the pattern nests too deeply.
@@ -55,7 +61,7 @@ pub enum MatchError {
     ValidationError,
     /// Returned if the pattern attempts an unsupported operation.
     ///
-    /// In particular, if the PatternTypes doesn't support `get` or `pairs`
+    /// In particular, if the [`PatternTypes`] doesn't support `get` or `pairs`
     /// for a given value, this error will be returned. It can be treated as a
     /// ValidationError, or as a bug in the pattern, at the user's discretion.
     UnsupportedOperation,