Jonathan> So, for this example: do you think the DESCRIPTION section of
Jonathan> git-fetch(1) should be reorganized like git-checkout(1) to
Jonathan> describe each form of the command separately?

Yes, except that the case of checkout is so horrifyingly unorthogonal
that it is _really_ hard (maybe impossible) to document it clearly.
fetch at least does more or less the same thing regardless, just on
different repos/branches.

Jonathan> Then in the description of each form, the meaning of each
Jonathan> argument could be discussed thoroughly, with pointers to
Jonathan> documentation elsewhere where appropriate.

This is what I meant by "some repetition will be necessary".  A few
pointers are OK but if you try to avoid repetition at all costs you
force a depth-first traversal of the entire set of manpages and the
prevailing reaction will be "git docs suck".

This is a bug with the manpage format, basically - the reason why GNU
deprecated them.

-- 
Ian Zimmerman
gpg public key: 1024D/C6FF61AD
fingerprint: 66DC D68F 5C1B 4D71 2EE5  BD03 8A00 786C C6FF 61AD
http://www.gravatar.com/avatar/c66875cda51109f76c6312f4d4743d1e.png
Rule 420: All persons more than eight miles high to leave the court.



-- 
To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org

Reply via email to