3 ms·
Thank you for this-- just the reply I was looking for. Out of curiosity, which man pages need the most work right now?
by wyclif 16y ago
Thank you for this-- just the reply I was looking for. Out of curiosity, which man pages need the most work right now?
- js2 16y agoHow about the fetch and push man pages: http://www.kernel.org/pub/software/scm/git/docs/git-fetch.html http://www.kernel.org/pub/software/scm/git/docs/git-fetch.ht... http://www.kernel.org/pub/software/scm/git/docs/git-push.html http://www.kernel.org/pub/software/scm/git/docs/git-push.htm... Even the summaries are terrible: git-fetch - Download objects and refs from another repository git-push - Update remote refs along with associated objects Now, I haven't been a git newbie in ages, but I imagine a beginner asking "what is this objects and refs about?" How about: git-fetch - Download changes from another repository git-push - Upload changes to another repository (Warning: there will be lots of back-and-forth on the mailing list about doc changes. Old timers tend to want the man pages to be technically correct, even though I think this makes the documentation harder on beginners. I suppose the argument is that the man pages are reference type documentation, but I still think there's lots of room for improvement.)
- freedrull 16y agoMan pages are suited to be as terse and technically correct as possible. I say leave the wording that is easier on beginners to web tutorials and books.