Faith Okamoto

👋🏽 My CV is available. 👋🏽

• Script docstrings

  What is this file, and why should I care?

  By Faith Okamoto

  Posted on September 24, 2024

  I advocate providing docstrings for scripts/modules/[whatever you call a code file]. In addition to describing the file in the README, by the way. Important information should be in multiple places. [Read More]

  Tags:

  • file-level
  • docstrings

• Describing parameters in docstrings

  (please do)

  By Faith Okamoto

  Posted on September 4, 2024

  Let’s dive into how and why docstrings should describe parameters. [Read More]

  Tags:

  • parameters
  • docstrings

• How I document code

  A brief overview of my process

  By Faith Okamoto

  Posted on August 27, 2024

  If you scan through this post, you might notice that there’s no code. Yep, I’m writing a blog post about how to document code without including any code. Instead, I’ll step through the higher-level plan I use for code documentation. [Read More]

  Tags:

  • process
  • last-pass

• Newer Posts