mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

comment

Browse source
This commit is contained in:
Joey Hess 2015-05-30 11:46:10 -04:00
parent 6e5cda4786
commit d856b8587f
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/todo/shorten_git-annex_manpage/comment_1_4b82eb4af9b923b23c6ecd8d355c0651._comment Normal file
View file

@ -0,0 +1,24 @@
[[!comment format=mdwn
username="joey"
subject="""comment 1"""
date="2015-05-30T15:36:45Z"
content="""
I don't like the "git-init" approach; git-init used to be in PATH,
but no longer is, so the git man page is really a bit broken now.
And of course, git-annex-undo is not actually a filename.
The second approach doesn't shorten it much and makes it harder
to skip over the boilerplate in the links when reading since it's moved
into the same paragraph as the description and will appear at differing
positions depending on the description length.
I'd rather make the command name be a hyperlink. However,
it's difficult to reconcile this with the limitations of man
pages.
Maybe aim for something like this in the man page display,
although I don't know if it can be accomplished:
undo [filename|directory] ... git-annex-undo(1)
Undo last change to a file or directory.
"""]]