Redstoner/redstoner-utils
Archived
0
Fork 0
Code Issues 6 Pull Requests Wiki Activity

add readability to coding guidelines

Browse Source
This commit is contained in:
jomo
2014-07-16 00:59:02 +02:00
parent 1a6e60fec4
commit 4d04d8df5b
1 changed files with 14 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14
View File
@@ -181,6 +181,20 @@ Leave two empty lines before function definitions. In case you need to use `@hoo
## Meaningful names ## Meaningful names
Give function and variable names meaningful names. If you want to shorten long names, that's fine, but leave a comment on assigment with the actual meaning. Give function and variable names meaningful names. If you want to shorten long names, that's fine, but leave a comment on assigment with the actual meaning.
## Readability
Don't create long lines with lots of function calls. Split into multiple lines instead.
```Python
# bad
foo = int(player_data[str(server.getPlayer(args[4]).getUniqueId())]["details"].["last_login"].strftime("%s"))
# good
player = server.getPlayer(args[4])
player_id = str(player.getUniqueId())
logintime = player_data[played_id]["last_login"]
epoch_time = int(logintime.strftime("%s"))
```
## Comments ## Comments
Comments are good! Comments are good!
Please comment everything that's non-obious or makes it easier to understand Please comment everything that's non-obious or makes it easier to understand