search

cnerg / py-template

Template for a new python project
MIT License
1 stars 1 forks source link

Create guidelines on code formatting #8

Open MicahGale opened 2 months ago

MicahGale commented 2 months ago

General thoughts:

  1. be PEP 8 compliant
  2. Functions should be short
  3. Comments should be sparing and helpful
  4. DOC STRINGS!
gonuke commented 2 months ago

Feel free to add these to the README (and as PR comments for my woefully inadequate PR #1)