Skip to content
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

Docstrings #96

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Conversation

okenreed
Copy link

Added and improved docstrings for all functions aside from main

@progval
Copy link
Contributor

progval commented Mar 18, 2019

Hi,

You included a lot of unrelated changes, please send a new PR without these or rebase this PR.

A few other changes that you should do:

  • Keep the line break before titles such at "Parameters" or "Returns", they make things more readable.
  • Please fix the alignment of docstring lines, they look almost random
  • Fix "W - Dec x speed" and "S - Inc x speed" and the two other ones, they are wrong (these keys change speed according to the player's orientation)
  • If a longer name does not give more info, keep the short name. eg. y always means height, so yHeight is redundant.
  • Use snake_case for variable names

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.

4 participants