From 350b2f621c654d8094a04fe8179563df6ec9122f Mon Sep 17 00:00:00 2001
From: jtmoon79 <815261+jtmoon79@users.noreply.github.com>
Date: Tue, 30 Aug 2022 21:25:17 +0000
Subject: [PATCH] add docstring to fn parse_rfc2822

---
 src/format/parse.rs | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/format/parse.rs b/src/format/parse.rs
index 02771b2e42..0dcda6dc17 100644
--- 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) => {{