Visitar URL original
Fix options in markdown doc, to prevent -- to become – in HTML by schoettl · Pull Request #954 · hledgerorg/hledger · GitHub
Skip to content

Fix options in markdown doc, to prevent -- to become – in HTML - #954

Closed
schoettl wants to merge 1 commit into
hledgerorg:masterfrom
schoettl:doc-fix-options
Closed

schoettl wants to merge 1 commit into
hledgerorg:masterfrom
schoettl:doc-fix-options

Conversation

@schoettl

Copy link
Copy Markdown
Contributor

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?

@simonmichael

Copy link
Copy Markdown
Member

@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.

@simonmichael simonmichael added A-BUG Something wrong, confusing or sub-standard in the software, docs, or user experience. docs Documentation-related. labels Jan 24, 2019
@schoettl

Copy link
Copy Markdown
Contributor Author

Hm, most options in the text are already quoted, I think. Shouldn't it be consistent?

And why

--qote, -q here at this option description – but not --inline?

@simonmichael

Copy link
Copy Markdown
Member

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.

simonmichael added a commit that referenced this pull request Jan 24, 2019
Eg: -- was being rendered as en-dash.

[ci skip]
@simonmichael

Copy link
Copy Markdown
Member

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.

@simonmichael

Copy link
Copy Markdown
Member

PS I don't understand what "--qote, -q here at this option description – but not --inline?" is referring to

@schoettl

Copy link
Copy Markdown
Contributor Author

@simonmichael what I mean is: If this was the man page of hledger:

usage: hledger [options]
options:
-q description of the option
-v verbose, cannot be used with -q

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.

@simonmichael

Copy link
Copy Markdown
Member

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..

@schoettl

Copy link
Copy Markdown
Contributor Author

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.

@simonmichael

Copy link
Copy Markdown
Member

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-BUG Something wrong, confusing or sub-standard in the software, docs, or user experience. docs Documentation-related.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants