# codingforchemists
Style for the book


Programming Style Guide

Header

    """
    Description of code
    Author
    Changelog reverse chronological - version date change
    """

Comments

    EOL comments, units first, unless too long, then on line before
    Explain a line: comment on the line immediately before, no blank link after, blank line before
    Explain a section of code: # blank line before, comment, # blank line after

Function def

    proper docstring

Function naming: Pascal style, generally NounVerbNoun

variable naming: Snake style, word_word or word_word_word, except proper names or preexisting quantity names


Generating images

    Figures - Helvetica font
    Plots - plotly default
    Diagrams - Draw.io


Latex

Figure Labels
fig:N/T:shortchap:name

Section Labels
sec:N/T:shortchap:name

Table
tab:N/T:shortchap:name

Code
code:N/T:shortchap:name

Problem
prob:N/T:shortchap:name

Index Keyword
kw:keyword