Created
March 10, 2019 17:33
-
-
Save CodeArtha/0b17e4f2afbcd967c63583f5a14c5c71 to your computer and use it in GitHub Desktop.
For all those times when I forget the best looking indentation I found for python because I don't use python often enough, courtesy of RayLuo@stackoverflow
This file contains 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
# Indentation suggestion from RayLuo for multiline lists, dicts, and functions arguments. | |
my_dictionary = { # Don't think dict(...) notation has more readability | |
"key1": 1, # Indent by one press of TAB (i.e. 4 spaces) | |
"key2": 2, # Same indentation scale as above | |
"key3": 3, # Keep this final comma, so that future addition won't show up as 2-lines change in code diff | |
} # My favorite: SAME indentation AS ABOVE, to emphasize this bracket is still part of the above code block! | |
the_next_line_of_code() # Otherwise the previous line would look like the begin of this part of code | |
bad_example = { | |
"foo": "bar", # Don't do this. Unnecessary indentation wastes screen space | |
"hello": "world" # Don't do this. Omitting the comma is not good. | |
} # You see? This line visually "joins" the next line when in a glance | |
the_next_line_of_code() | |
btw_this_is_a_function_with_long_name_or_with_lots_of_parameters( | |
foo='hello world', # So I put one parameter per line | |
bar=123, # And yeah, this extra comma here is harmless too; | |
# I bet not many people knew/tried this. | |
# Oh did I just show you how to write | |
# multiple-line inline comment here? | |
# Basically, same indentation forms a natural paragraph. | |
) # Indentation here. Same idea as the long dict case. | |
the_next_line_of_code() | |
# By the way, now you see how I prefer inline comment to document the very line. | |
# I think this inline style is more compact. | |
# Otherwise you will need extra blank line to split the comment and its code from others. | |
some_normal_code() | |
# hi this function is blah blah | |
some_code_need_extra_explanation() | |
some_normal_code() |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment