Closed Jk40git closed 8 months ago
The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)
If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Data rooms once you're in. It'd be great to have you!
[x] The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution
git config user.email
in their local Scribe-Data repo[x] The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)
Hey @Jk40git. I see that there's still some confusion here. The goal os this is not to have the same documentation string for all of the functions. The document string is for the arguments of the function, so we just need to reformat it and put the arguments of the function in the right place. I'll annotate the code a bit to explain what I'm talking about.
Let me know if the examples help with what we're asking for here, @Jk40git! Would be great if you could make changes for here and #65.
Hey @Jk40git. I see that there's still some confusion here. The goal os this is not to have the same documentation string for all of the functions. The document string is for the arguments of the function, so we just need to reformat it and put the arguments of the function in the right place. I'll annotate the code a bit to explain what I'm talking about.
Please check the edits I have just made
A couple more edits this time around, @Jk40git, but generally ok. Many of the parameter descriptions needed to be on a new line, and there we're some minor things like the dashes not being the same length as
Parameters
andReturns.
@andrewtavis they are already on new lines or what do you mean please (the indentation)?
Changes made on the docstrings
Contributor checklist
Description
Related issue
ISSUE_NUMBER