From 15bb96ba22865f77053c3017bf2008f190a8d967 Mon Sep 17 00:00:00 2001
From: Caleb Jones <code@calebjones.net>
Date: Fri, 30 Dec 2016 17:54:05 -0500
Subject: [PATCH] Put allow(missing_docs) on the internal parser functions
---
src/parser.rs | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/src/parser.rs b/src/parser.rs
index e457aab..1816afc 100644
--- a/src/parser.rs
+++ b/src/parser.rs
@@ -176,6 +176,10 @@ pub fn parse_one(input: &str) -> Result<(Sexp, &str), ParseError> {
// Core Parsers ////////////////////////////////////////////////////////////////
+// TODO: All of these parsers deserve docs, but since they're somewhat internal
+// parsers, it's less critical than the rest of the API.
+
+#[allow(missing_docs)]
pub fn parse_expression(input: &str, start_loc: usize) -> ParseResult<Sexp, ParseError> {
let (input, start_loc) = consume_whitespace!(input, start_loc, ParseError::Sexp);
@@ -189,6 +193,7 @@ pub fn parse_expression(input: &str, start_loc: usize) -> ParseResult<Sexp, Pars
}
}
+#[allow(missing_docs)]
pub fn parse_list(input: &str, start_loc: usize) -> ParseResult<Sexp, ParseError> {
let (input, start_loc) = consume_whitespace!(input, start_loc, ParseError::List);
@@ -233,6 +238,7 @@ pub fn parse_list(input: &str, start_loc: usize) -> ParseResult<Sexp, ParseError
}
}
+#[allow(missing_docs)]
pub fn parse_number(input: &str, start_loc: usize) -> ParseResult<Sexp, ParseError> {
let (input, start_loc) = consume_whitespace!(input, start_loc, ParseError::Number);
@@ -299,6 +305,7 @@ pub fn parse_number(input: &str, start_loc: usize) -> ParseResult<Sexp, ParseErr
(0, input.len()).offset(start_loc)))
}
+#[allow(missing_docs)]
pub fn parse_symbol(input: &str, start_loc: usize) -> ParseResult<Sexp, ParseError> {
let (input, start_loc) = consume_whitespace!(input, start_loc, ParseError::Symbol);
@@ -326,6 +333,7 @@ pub fn parse_symbol(input: &str, start_loc: usize) -> ParseResult<Sexp, ParseErr
Sexp::Sym(input.into(), (0, input.len()).offset(start_loc)))
}
+#[allow(missing_docs)]
pub fn parse_string(input: &str, start_loc: usize) -> ParseResult<Sexp, ParseError> {
let (input, start_loc) = consume_whitespace!(input, start_loc, ParseError::String);
@@ -350,6 +358,7 @@ pub fn parse_string(input: &str, start_loc: usize) -> ParseResult<Sexp, ParseErr
(0, input.len()).offset(start_loc)))
}
+#[allow(missing_docs)]
pub fn parse_character(input: &str, start_loc: usize) -> ParseResult<Sexp, ParseError> {
let (input, start_loc) = consume_whitespace!(input, start_loc, ParseError::Char);
--
2.47.0