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

console rendering of slash continued multi-line commands #328

Closed
peterjc opened this issue Jan 27, 2020 · 2 comments
Closed

console rendering of slash continued multi-line commands #328

peterjc opened this issue Jan 27, 2020 · 2 comments

Comments

@peterjc
Copy link

peterjc commented Jan 27, 2020

GitHub's rending of reStructuredText marked up with the "console" language code snippets is broken.

(Apologies if this is the wrong place to report this - please redirect me if needed)

Bash and other terminals support ending a line with slash (\) and an immediate new line (\n) to indicated the command line continues. This convention is commonly used in documentation as a way to add explicit line breaks to split long commands visually on a restricted screen on page width.

The continued command on the second lines onwards should be formatted like the first line of the command (black) and not as part of the potential command output (blue), e.g.

https://github.com/peterjc/thapbi-pict/blob/v0.6.4/docs/worked_example/sample_summary.rst

Cross reference pygments/pygments#1368 (pygments works as long as the lines end slash new line with no trailing space), but having done more reading I'm not sure that GitHub or html-pipeline are using pygments by default any more?

@gjtorikian
Copy link
Owner

Please log issues with how GitHub renders markup with their support team: https://support.github.com/

@peterjc
Copy link
Author

peterjc commented Jan 27, 2020

Done, thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants