Tag Index

 comments (8) debugging (1) docstrings (3) documentation (13) dry (2) errors (4) examples (3) file-level (3) getting-started (1) hardcoding (1) imports (1) installation (1) last-pass (6) logs (1) meta (2) motivation (1) naming (5) optimization (1) parameters (5) pipeline (1) plots (2) process (5) published-code-critique (15) readability (1) readme (5) refactoring (4) science-meaning (2) software (1) style (4) testing (3) tutorials (1) usability (1) whitespace (1)

 comments (8)

Your abbreviations are not obvious
Understanding an API
But why?
Simplicity does not excuse bad comments
Double-check your comments
Explain your science
Crediting sources in your code
Repetitive comments

 debugging (1)

How verbose is that log?

 docstrings (3)

In praise of writing documentation
Script docstrings
Describing parameters in docstrings

 documentation (13)

Sometimes the example should be big(ger)
Understanding an API
Documenting the magic button
Revamping documentation
Documentation and mega-tools
Provide context for code
Documenting options
Directory READMEs
A pretty good README
The art of toy data
Use data files
Help others help you
In praise of writing documentation

 dry (2)

Extracting the core
Don't Repeat Yourself

 errors (4)

Quality of life updates
Include sources in error messages
Parameters implying other parameters
Useful error messages

 examples (3)

Sometimes the example should be big(ger)
Examining demo code samples
The art of toy data

 file-level (3)

Directory READMEs
Organizing files for code
Script docstrings

 getting-started (1)

Documentation and mega-tools

 hardcoding (1)

Config files vs. hardcoding

 imports (1)

Including version numbers in your code

 installation (1)

Tell me how to install this

 last-pass (6)

Updating explanations of meaning
Double-check your comments
Don't Repeat Yourself
Reproduce your work
Do a final cleanup
How I document code

 logs (1)

How verbose is that log?

 meta (2)

Schedule update
One year later

 motivation (1)

The joy of tidying code

 naming (5)

Your abbreviations are not obvious
Using simple structs
Use data files
Help others help you
Using keyword arguments

 optimization (1)

Optimization vs. readability

 parameters (5)

Config files vs. hardcoding
Parameters implying other parameters
Documenting options
Using keyword arguments
Describing parameters in docstrings

 pipeline (1)

Documenting the magic button

 plots (2)

Config files vs. hardcoding
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 (15)

Your abbreviations are not obvious
Spacing out
Understanding an API
But why?
Examining demo code samples
Documentation and mega-tools
Tell me how to install this
Simplicity does not excuse bad comments
Provide context for code
Double-check your comments
Format your code
A pretty good README
Use data files
Help others help you
Do a final cleanup

 readability (1)

Spacing out

 readme (5)

Documentation and mega-tools
Tell me how to install this
Provide context for code
Directory READMEs
A pretty good README

 refactoring (4)

The joy of tidying code
Revamping documentation
Optimization vs. readability
Extracting the core

 science-meaning (2)

Updating explanations of meaning
Explain your science

 software (1)

Including version numbers in your code

 style (4)

Things I care about too much
Format your code
Magic numbers in plotting
Don't Repeat Yourself

 testing (3)

Developing a testing script
Automated tests
The art of toy data

 tutorials (1)

Sometimes the example should be big(ger)

 usability (1)

Quality of life updates

 whitespace (1)

Spacing out