Skip to content

Unify format & syntax across Python tutorial #379

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

Merged
merged 3 commits into from
Jan 28, 2018
Merged

Unify format & syntax across Python tutorial #379

merged 3 commits into from
Jan 28, 2018

Conversation

danielquinn
Copy link
Contributor

There were a number of inconsistencies in how the tutorial presents code, most commonly with using >>> sometimes and regularly just typing out the variable name to mean "let the REPL tell you what this means" rather than using print(variable_name). This PR fixes both of those, along with some general clean up.

Parts of these tutorials were indented with tabs, and others with 4
spaces.  This conforms them all to 4 spaces.
One of my students last night got confused with the tutorial where we
weren't directly calling `print()` and yet stuff was appearing on the
screen.  She wasn't sure if simply typing out the variable was somehow
*doing* something.  Using `print()` explicitly everywhere should clear
this up.

Similarly, `>>> ` was only being used in parts of the document, leaving
it unclear as to whether this is something that needs to be typed, or if
perhaps the absence of it meant they weren't in the REPL.

This commit addressed both issues.
I think this is probably clearer and more grammatically correct.
Copy link
Contributor

@KimberleyCook KimberleyCook left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thank you :)

@KimberleyCook KimberleyCook merged commit ca24f05 into codebar:gh-pages Jan 28, 2018
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

Successfully merging this pull request may close these issues.

2 participants