Closed terriko closed 12 months ago
I’ll be working on this.
I want to work on it assign me!
@AryanBakliwal spoke first, so I've assigned them this issue!
Oh, wait, I've realized that @AryanBakliwal also claimed #3463 . In the interest of sharing out more easy issues, I'm going to leave #3563 assigned to @AryanBakliwal but let @shivam200446 take this one.
closed by #3489
We haven't been entirely consistent about adding python docstrings to every function, and I'd like to start improving the codebase. I'm filing separate tickets for each file I want updated so hacktoberfest folk can claim them more easily -- please only claim one or two at a time.
Here's a tutorial on docstrings in case you're not sure what they are. Basically I want someone to write a short sentence explaining what a function does and have it put at the top of the function in the way that python expects docstrings to look. (You can also do classes and methods.)
This issue is for updating the file f
output_engine/pdfbuilder.py
.interrogate
(a tool for checking docstrings) says it's missing the following docstrings:interrogate -vv -i -I -M -C data_sources/curl_source.py
You will need to actually read the file and figure out what it does, then describe each function. Feel free to ask questions if you're not sure, or submit a partial fix where you only add docstrings to some functions.
Short tips for new contributors:
Claiming issues: