Fix Context Managers examples #3
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`\begincenter` and `\endcenter` don't exist in LaTeX and the example code does not produce the expected result due to missing escape sequences for the backslash and curly braces. The example changes once you switch to raw strings, where backslashes do not need to be escaped, but curly braces still do. I have fixed the strings and outputs, and changed the 2nd and 3rd example to use simple strings instead of raw strings. Readers may not catch that the switch happens which adds to confusion since backslashes need to be escaped in simple strings, but not in raw strings. You also may want to consider adding a note, that even through the output will display two backslashes, the actual string only has one backslash. Finally the `may_error()` part could become very confusing, especially when people execute the code and get different results from the ones you printed and, even worse, potentially varying results if they run the example multiple times.
|
Thanks for the PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
\begincenterand\endcenterdon't exist in LaTeX and the example code does not produce the expected result due to missing escape sequences for the backslash and curly braces. The example changes once you switch to raw strings, where backslashes do not need to be escaped, but curly braces still do.I have fixed the strings and outputs, and changed the 2nd and 3rd example to use simple strings instead of raw strings. Readers may not catch that the switch happens which adds to confusion since backslashes need to be escaped in simple strings, but not in raw strings.
You also may want to consider adding a note, that even through the output will display two backslashes, the actual string only has one backslash.
Finally the
may_error()part could become very confusing, especially when people execute the code and get different results from the ones you printed and, even worse, potentially varying results if they run the example multiple times.