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

Fix code block formatting in Documentation #3442

Merged
merged 5 commits into from Apr 10, 2018

Conversation

Projects
None yet
2 participants
@stevoisiak
Contributor

stevoisiak commented Apr 3, 2018

Several pages in the documentation have code-blocks improperly formatted as quote blocks. This leads to commands being displayed improperly.

For example, in operating-mode.rst, the option for single-executable mode:

pyinstaller --onefile --windowed myscript.py

Incorrectly renders with a single dash, causing the command to fail.

pyinstaller -onefile -windowed myscript.py

stevoisiak added some commits Apr 3, 2018

intallation.rst: Fix code block formatting
Code blocks were previously formatted as quoted text. Changed to using `::` for code blocks.

@stevoisiak stevoisiak changed the title from Patch 1 to Fix code block formatting in Documentation Apr 3, 2018

@stevoisiak stevoisiak changed the title from Fix code block formatting in Documentation to (WIP) Fix code block formatting in Documentation Apr 3, 2018

@htgoebel

Thanks for reporting these ans sorry for any inconvenience cause by this bugs. You marked this as "wip", so please drop me a note (or mention) when you are finished. Thanks.

This creates a new virtual environment rooted at ``C:\Python\pyi-env-name``
and makes it the current environment.
A new command shell
window opens in which you can run commands within this environment.
Enter the command
Enter the command::

This comment has been minimized.

@htgoebel

htgoebel Apr 3, 2018

Member

Quick reStructuredText says: "The :: will be omitted if it is preceded by whitespace." So I suggest adding a space in front, since the sentence continues over the literal block. Same for the other places.

@@ -13,12 +13,12 @@ the active Python interpreter! -- and puts them with
your script in a single folder,
or optionally in a single executable file.
For the great majority of programs, this can be done with one short command,
For the great majority of programs, this can be done with one short command::

This comment has been minimized.

@htgoebel

htgoebel Apr 3, 2018

Member

... and here. command, :: should allow to keep the comma.

@htgoebel

This comment has been minimized.

Member

htgoebel commented Apr 7, 2018

@stevoisiak Are you finished working on this?

@stevoisiak stevoisiak changed the title from (WIP) Fix code block formatting in Documentation to Fix code block formatting in Documentation Apr 9, 2018

stevoisiak added some commits Apr 9, 2018

@stevoisiak

This comment has been minimized.

Contributor

stevoisiak commented Apr 9, 2018

@htgoebel I've made the requested changes. This should be good to squash and merge.

There are a few other documentation pages with the same issue, but I will try to look at those in a future PR.

FIXUP
[skip ci]

@htgoebel htgoebel merged commit eea4796 into pyinstaller:develop Apr 10, 2018

1 check was pending

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details

@stevoisiak stevoisiak deleted the stevoisiak:patch-1 branch Apr 11, 2018

@htgoebel htgoebel added this to the PyInstaller 3.4 milestone Sep 2, 2018

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