add docstring to fn parse_rfc2822

chronotope · Aug 30, 2022 · 350b2f6 · 350b2f6
1 parent 3828399
commit 350b2f6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/format/parse.rs b/src/format/parse.rs
@@ -42,6 +42,10 @@ fn set_weekday_with_number_from_monday(p: &mut Parsed, v: i64) -> ParseResult<()
     })
 }
 
+/// Parse an RFC 2822 format datetime
+/// e.g. `Fri, 21 Nov 1997 09:55:06 -0600`
+///
+/// This function allows arbitrary intermixed whitespace per RFC 2822 appendix A.5
 fn parse_rfc2822<'a>(parsed: &mut Parsed, mut s: &'a str) -> ParseResult<(&'a str, ())> {
     macro_rules! try_consume {
         ($e:expr) => {{