scribe-org / Scribe-Data

Wikidata, Wiktionary and Wikipedia language data extraction
GNU General Public License v3.0
30 stars 69 forks source link

Update checkquery.py #64

Closed Jk40git closed 8 months ago

Jk40git commented 9 months ago

Changes made on the docstrings

Contributor checklist


Description

Related issue

github-actions[bot] commented 9 months ago

Thank you for the pull request!

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!

Maintainer checklist

andrewtavis commented 9 months ago

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.

andrewtavis commented 9 months ago

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.

Jk40git commented 9 months ago

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

Jk40git commented 8 months ago

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 and Returns.

@andrewtavis they are already on new lines or what do you mean please (the indentation)?