Today I went down a long rabbit hole trying to solve a linting error for a coworker. Our team at ShopRunner uses numpy docstrings, and we check our code with flake8 and flake8-docstrings.

My coworker had written a method that looked like this:

def my_sweet_method(self, examples):   """
   This is a dope docstring.
   
   Parameters
   ----------
   examples
       str inputs to be tokenized   Returns
   -------
   Tokenized strings
   """
   ...

When we ran flake8, we kept getting this error “D414 Section has no content” on the first line of the docstring (“This is a dope docstring”). …