search

oscarmlage / django-cruds-adminlte

django-cruds is simple drop-in django app that creates CRUD for faster prototyping
BSD 3-Clause "New" or "Revised" License
424 stars 81 forks source link

Specify code style guide #129

Open telenieko opened 4 years ago

telenieko commented 4 years ago

The contributing guide does not specify any code style. the obvious "respect pep 8" is easy, but...

What format do we prefer for docstrings? This SO post has some samples: https://stackoverflow.com/a/24385103/1819160.

I kind of like Google's style because it is more readable as-is, and it is supported by Sphinx so docs are the same once rendered. https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html#example-google

Please drop your 0.02 so the contributing guide can be updated.

oscarmlage commented 4 years ago

Google's style is ok with me, let me drop the link, I think it would be helpful for the future: