-
Notifications
You must be signed in to change notification settings - Fork 443
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add missing docstrings to log.py #3383
Comments
Hello @terriko , hope you are doing well. It will be really helpful if you can help me with a few questions because I am new to this. If I am understanding correctly I need to add the docstrings for L12 and L17, so do I need to give a descriptive one or a simple single line would work ? |
Since these are very simple, I think a one-liner would suffice, but you can be more explicit if you'd like. There may already be comment text in the file you can move/re-use. |
Ok thank you very much. I will start working on it |
Please assign me this issue? |
I have already raised a pr for this, that already closes this issue
…On Mon, 9 Oct 2023, 6:48 pm Surya, ***@***.***> wrote:
Please assign me this issue?
—
Reply to this email directly, view it on GitHub
<#3383 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AWIRDIWJE2CXTGT7XNAXJYDX6P2TBAVCNFSM6AAAAAA5S3JH2CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTONJSHE4TSMRQHE>
.
You are receiving this because you were assigned.Message ID:
***@***.***>
|
@SuryaCreatX if you're still looking for an issue to work on, I added a few new ones today that (as of right now) haven't been claimed by anyone: #3409 and #3410 |
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 log.py.
interrogate
(a tool for checking docstrings) says it's missing the following docstrings:-------------------------------------------------- Detailed Coverage ---------------------------------------------------
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:
The text was updated successfully, but these errors were encountered: