Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

man page: lists not formatted properly #20558

Closed
tbm opened this issue Apr 4, 2019 · 3 comments
Closed

man page: lists not formatted properly #20558

tbm opened this issue Apr 4, 2019 · 3 comments

Comments

@tbm
Copy link
Contributor

@tbm tbm commented Apr 4, 2019

Some lists in the man page are not shown as lists but as one long paragraph, e.g.

"You can also use special names to select particular edge case formats: - best: Select the best quality format represented by a single file with video and audio. - worst: Select the"

I'll propose a PR.

@tbm tbm mentioned this issue Apr 4, 2019
5 of 9 tasks complete
@tbm
Copy link
Contributor Author

@tbm tbm commented Apr 6, 2019

@dstftw have you looked at the man page? man -l youtube-dl.1 Search for the string I mentioned and you'll see that instead of being a list, it's all in one paragraph.

@tbm
Copy link
Contributor Author

@tbm tbm commented Apr 6, 2019

In fact, you can also look at the README.txt that is auto-generated with pandoc:

You can also use special names to select particular edge case formats: -
best: Select the best quality format represented by a single file with
video and audio. - worst: Select the worst quality format represented by
...

This is with pandoc 2.2.1 btw.

@tbm
Copy link
Contributor Author

@tbm tbm commented Apr 6, 2019

Test case:

$ cat t

foo:
 - bar
 - baz

foo:

 - bar
 - baz

$ pandoc -f markdown < t -t plain
foo: - bar - baz

foo:

-   bar
-   baz

Do you get a different result with pandoc?

@dstftw dstftw closed this in #20559 Apr 6, 2019
dstftw added a commit that referenced this issue Apr 6, 2019
Lists have to be separated from the previous paragraph by a blank line
in certain variants of Markdown, otherwise they are not interpreted as
lists.

This change ensures that that the youtube-dl.1 man page, which is
generated from README.md with the help of pandoc, is formatted
correctly.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

2 participants
You can’t perform that action at this time.