https://github.com/astrocatalogs/astrocats
Raw File
Tip revision: 4fd2a73919c9fa8e206059b376f5506a01756a73 authored by guillochon on 23 July 2016, 13:36:19 UTC
DOCS: fix some docstrings
Tip revision: 4fd2a73
DEVELOP.md
# AstroCats Development README #

## Structure and Code Style ##

Unless otherwise noted, everything should be
[PEP8](https://www.python.org/dev/peps/pep-0008) compliant, with 79 characters
maximum per line (we ignore the 72 character docstring maximum).  Please make
variable names descriptive, and add comments describing *everything*.  Avoid
the use of literals whenever possible - using/defining/documenting constants
appropriately.

## Naming Conventions ##
-   Directories: `lowercase`,  
-   Files: `lowercase`  
-   Classes: `TitleCase`  
-   Variables: `lower_case` (i.e. underscores for breaks/spaces)
    -   Constants: `UPPER_CASE`
back to top