diff options
| author | Marc Branchaud <marcnarc@xiplink.com> | 2013-08-01 14:49:54 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-08-01 13:13:52 -0700 |
| commit | 42e0fae98e592c296aa5726c9dfd41ef255d1299 (patch) | |
| tree | 510c76777dbdb6ced4cbd737cf34cf6ef6aadbf8 /Documentation/CodingGuidelines | |
| parent | 8dc84fdc48a79c70682e6c361a82d0f3e1db9a03 (diff) | |
| download | git-42e0fae98e592c296aa5726c9dfd41ef255d1299.tar.gz | |
Provide some linguistic guidance for the documentation.mb/docs-favor-en-us
This will hopefully avoid questions over which spelling and grammar should
be used. Translators are of course free to create localizations for
specific English dialects.
Signed-off-by: Marc Branchaud <marcnarc@xiplink.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/CodingGuidelines')
| -rw-r--r-- | Documentation/CodingGuidelines | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 559d5f9ebf..e5ca3b75d3 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -242,6 +242,14 @@ Writing Documentation: processed into HTML and manpages (e.g. git.html and git.1 in the same directory). + The documentation liberally mixes US and UK English (en_US/UK) + norms for spelling and grammar, which is somewhat unfortunate. + In an ideal world, it would have been better if it consistently + used only one and not the other, and we would have picked en_US + (if you wish to correct the English of some of the existing + documentation, please see the documentation-related advice in the + Documentation/SubmittingPatches file). + Every user-visible change should be reflected in the documentation. The same general rule as for code applies -- imitate the existing conventions. A few commented examples follow to provide reference |