Faith Okamoto

👋🏽 My CV is available. 👋🏽

• Repetitive comments

  Comments that repeat the code (;D)

  By Faith Okamoto

  Posted on October 14, 2024

  I’ve been using ChatGPT to write code for a class. (This is explicitly encouraged by the professor.) Its default style has one of my pet peeves: comments that do nothing but repeat the code. The LLM does this because, its training data, lots and lots of humans wrote these kinds... [Read More]

  Tags:

  • comments

• Including version numbers in your code

  What do I need to run this thing?

  By Faith Okamoto

  Posted on October 6, 2024

  You should always specify the versions of any code dependencies. Perhaps not so far as the exact Windows operating system. But, using package versions 1.1.0 or 1.2.1 can and does affect the code. [Read More]

  Tags:

  • imports
  • software

• 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