threads / discuss / 13838

General question about minimal documentation patches

Subject: General question about minimal documentation patches

## tl;dr

4 messages between Jun 6, 2008 and Jun 6, 2008.

replies: 3people: 4as markdown or json

Dirk Süsserott· Jun 6, 2008, 22:23 UTC · lore
This is a general question about documentation patches:

Do you mind if people submit _very_ minimal patches for the docs that fix only some typing errors or the like? I, personally, am a friend of correct spelling and such and when I discover such errors I prefer to have them fixed.

OTOH, I really don't want to bother you with such patches that don't bring forward the "real Git" and only marginally contribute to Git itself. I know that all of you have better things to do than adding a punctuation mark somewhere or checking a patch that does it.

    -- Dirk
Robert Anderson· Jun 6, 2008, 22:39 UTC · re: Dirk Süsserott · lore

Re: General question about minimal documentation patches

On Fri, Jun 6, 2008 at 3:23 PM, Dirk Süsserott <newsletter@dirk.my1.cc> wrote:
> OTOH, I really don't want to bother you with such patches
> that don't bring forward the "real Git" and only marginally
> contribute to Git itself.

As a new-ish user of git who spends a lot of time in the docs: please do it. These problems range from distracting to downright confusing.

Bob
Stephan Beyer· Jun 6, 2008, 22:46 UTC · re: Dirk Süsserott · lore

Re: General question about minimal documentation patches

Hi,
> Do you mind if people submit _very_ minimal patches for the
> docs that fix only some typing errors or the like? I, personally,
> am a friend of correct spelling and such and when I discover
> such errors I prefer to have them fixed.

I don't see a reason why tiny documentation fixes (be it typos or not) should be less important than tiny feature code fixes, so imho it is totally ok ;-)

Out of curiosity I looked for typo-only fixes in git, and found:
88f6dbaf99f43053f86474b28beedd91e77c64d9
	builtin-apply: typofix
e77b0b5d0fdac411607dbae11ccad87dccd332d3
	git-am: fix typo in usage message
ed020917147ca733477a0186f3bb1791ec6e5b5c
	Documentation/git-web--browse.txt: fix small typo
51836e9e125f67aa26724154757b4734c08057e4
	Documentation/git-submodule: typofix
ca593f795994badf7cd543d24d1ed24aabc0d8e1
	Documentation/git-request-pull: Fixed a typo ("send" -> "end")
and so on ;-)
What I want to say: just send the patches in ;-)
Regards,
  Stephan
-- 
Stephan Beyer <s-beyer@gmx.net>, PGP 0x6EDDD207FCC5040F
Miklos Vajna· Jun 6, 2008, 22:47 UTC · re: Dirk Süsserott · lore

Re: General question about minimal documentation patches

On Sat, Jun 07, 2008 at 12:23:36AM +0200, Dirk Süsserott <newsletter@dirk.my1.cc> wrote:
> Do you mind if people submit _very_ minimal patches for the
> docs that fix only some typing errors or the like? I, personally,
> am a friend of correct spelling and such and when I discover
> such errors I prefer to have them fixed.

Sure, just do it. I think the first patch of most of us was such a small documentation typo fix: see 31cedfb. ;-)

← back to recent threads