Repository navigation
Conversation
|
@schoettl thanks, I overlooked this. I think a better fix would be to turn off pandoc's "smart typography", which I always try to do. That way we won't have to worry about this. |
|
Hm, most options in the text are already And why
|
|
Perhaps we should be more consistent about quoting options, we can discuss that too. But I'll turn off the (not-so-)smart typography in any case, as it breaks searching and copy/pasting from examples. I'm working on this, it is having some strange effect in the nroff manuals. |
Eg: -- was being rendered as en-dash. [ci skip]
|
Rebuilt all site content, fixing eg http://hledger.org/hledger-ui.html -> "--forecast and --auto are always on". I'm not sure that flags should always be quoted, eg in a place like that. Sometimes it seems to disturb the reader's flow. Sometimes I quote them and it leads to quoting more and soon it seems too much. We do need some kind of policy on this. |
|
PS I don't understand what "--qote, -q here at this option description – but not --inline?" is referring to |
|
@simonmichael what I mean is: If this was the man page of hledger: usage: hledger [options] I think, if we quote the options in the first column describing the option, it should also be quoted when used inline of the description text. |
|
I see one case of that in the hledger-ui manual: "-U --unmarked include only unmarked postings/txns (can combine with -P or -C) " and I must say it looks fine either way to me.. |
|
Right, it doesn't look bad per se, but I prefer consistency. Consider the sections Depth limiting and Pivoting – here the options even have parameters and this would look --like THIS if not quoted. Here I clearly, prefer quoting. |
|
I think I'll close this PR. We can discuss the larger issue (clarify the formatting policy in docs for flags, etc.) more on mail list, irc, or (if specific) a new issue. Thanks! |
I quoted
-f/--flag, to prevent it from becoming –flag in HTML doc.I haven't compiled the doc to nroff, info, ... but it should work, right?