Skip to content

Updated STYLE.md for code formatting consistency #9

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.

Sign up for GitHub

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

Open
cooper-mj wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Updated STYLE.md for code formatting consistency #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d9e7b0
Updated STYLE.md for code formatting consistency
cooper-mj Aug 23, 2020
7768886
Removing the changes about two spaces offsetting the return value
parthsarin Aug 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions STYLE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,12 @@ longer_expression # => long_return_val
really_long_expression # => really_long_return_val
```

When an expression will result in printed terminal output, this should be written after the expression and a blank line. Each line of output should be commented out with the hash sign at the beginning of the line, a space, and then the terminal output. The implication sign should not be included.

For example
When an expression will result in printed terminal output, this should be written using the syntax above, with the console (`>`) sign in place of the implication sign. If output takes place over multiple lines, the console sign should appear _on the first line only_, and spacing should indicate that subsequent lines are printed from the same expression, as below:

```python
expression_that_prints_something

# Line 1 of output
# Line 2 of output
# Line 3 of output
exp_multiline_output() # > Line 1 of output
# Line 2 of output
# Line 3 of output
```

## Images
Expand Down