docs: adding missing docstrings meta-issue

[terriko]

I've been slowly adding issues like #3455 intended for folk participating in hacktoberfest to have an easy first issue that gets them some practice reading and understanding an unfamilar codebase. I'm one person serving as project lead and it takes a bit of time for me to find files that are worth upgrading, make an issue, and handle code review.

If you're looking for a good first issue, though, feel free to create one for yourself in a similar way. I'm using the tool interrogate to examine files using the following flags in each directory:

interrogate -vv -i -I -M -C *.py

And then filing an issue for each file that's missing stuff. If you want to file your own issue and then work on it, feel free to use a similar procedure.

• don't forget to double-check that there isn't already a docstring issue filed for that file
• if you intend to solve the issue you filed yourself, say so so I know to prioritize you as the person who gets the merged PR. But also feel free to file some extra issues for other people if you're bored (sadly, this won't get you any hacktoberfest credit, but you'll save me some hassle!)

[Willmayyy]

can i be assigned

[terriko]

@Willmayyy this isn't really the type of issue one gets assigned to since it's just an explanation of how to make new issues of the same type. But if you follow the instructions and make an issue for a file that doesn't have one, I'd be happy to assign you to your own issue!

[terriko]

I think we've pretty much got docstrings to a good point and interrogate is now pushing us to keep up the good work, so I'm going to go ahead and close this issue. We can revisit it again at some future date if we want to make a few more beginner-friendly issues with the last missing docstrings.