diff mbox series

[RFC] doc: change 'The standard email format' to 'The standard date format'

Message ID 20190601201212.19165-1-zombieleetnca@gmail.com (mailing list archive)
State New, archived
Headers show
Series [RFC] doc: change 'The standard email format' to 'The standard date format' | expand

Commit Message

Victory Osikwemhe June 1, 2019, 8:12 p.m. UTC
The current content of date-formats.txt under the RFC 2822 section
specifies 'The standard email format' whereas the format specified
is a date format

Signed-off-by: Victory Osikwemhe <zombieleetnca@gmail.com>
---
 Documentation/date-formats.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Eric Sunshine June 2, 2019, 6:33 a.m. UTC | #1
On Sat, Jun 1, 2019 at 4:12 PM Victory Osikwemhe
<zombieleetnca@gmail.com> wrote:
> The current content of date-formats.txt under the RFC 2822 section
> specifies 'The standard email format' whereas the format specified
> is a date format
>
> Signed-off-by: Victory Osikwemhe <zombieleetnca@gmail.com>
> ---
> diff --git a/Documentation/date-formats.txt b/Documentation/date-formats.txt
> @@ -14,7 +14,7 @@ Git internal format::
>  RFC 2822::
> -       The standard email format as described by RFC 2822, for example
> +       The standard date format as described by RFC 2822, for example
>         `Thu, 07 Apr 2005 22:13:13 +0200`.

Given that not everyone is going to know (or be motivated to discover)
that RFC 2822 is about email, I wonder if this change could make the
text even more self-describing by instead saying this:

    The standard email date format ...
diff mbox series

Patch

diff --git a/Documentation/date-formats.txt b/Documentation/date-formats.txt
index 6926e0a4c8..1e1acb3826 100644
--- a/Documentation/date-formats.txt
+++ b/Documentation/date-formats.txt
@@ -14,7 +14,7 @@  Git internal format::
 	For example CET (which is 1 hour ahead of UTC) is `+0100`.
 
 RFC 2822::
-	The standard email format as described by RFC 2822, for example
+	The standard date format as described by RFC 2822, for example
 	`Thu, 07 Apr 2005 22:13:13 +0200`.
 
 ISO 8601::