Tag Index

 comments (3) docstrings (3) documentation (5) errors (1) file-level (2) imports (1) last-pass (4) naming (3) parameters (2) plots (1) process (5) published-code-critique (4) science-meaning (1) software (1) style (2) testing (1)

 comments (3)

Explain your science
Crediting sources in your code
Repetitive comments

 docstrings (3)

In praise of writing documentation
Script docstrings
Describing parameters in docstrings

 documentation (5)

A pretty good README
The art of toy data
Use data files
Help others help you
In praise of writing documentation

 errors (1)

Useful error messages

 file-level (2)

Organizing files for code
Script docstrings

 imports (1)

Including version numbers in your code

 last-pass (4)

Don't Repeat Yourself
Reproduce your work
Do a final cleanup
How I document code

 naming (3)

Use data files
Help others help you
Using keyword arguments

 parameters (2)

Using keyword arguments
Describing parameters in docstrings

 plots (1)

Magic numbers in plotting

 process (5)

Don't Repeat Yourself
Reproduce your work
Keeping a "dry lab" lab notebook
Organizing files for code
How I document code

 published-code-critique (4)

A pretty good README
Use data files
Help others help you
Do a final cleanup

 science-meaning (1)

Explain your science

 software (1)

Including version numbers in your code

 style (2)

Magic numbers in plotting
Don't Repeat Yourself

 testing (1)

The art of toy data