Update checkquery.py

[Jk40git]

Changes made on the docstrings

Contributor checklist

• [] This pull request is on a separate branch and not the main branch

---

Description

Related issue

• #ISSUE_NUMBER

[github-actions]

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

• 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

  • The contributor's name and icon in remote commits should be the same as what appears in the PR
  • If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-Data repo

• The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

[andrewtavis]

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]

We want this here to be the same as it was before, but with a different format for the Returns:. So ideally:

Returns
--------
    str : the SPARQL query.

[andrewtavis]

Here we need message and query, the arguments of the function.

[andrewtavis]

Here we need url and timeout.

[andrewtavis]

We need this to be bool : True if connectivity established. False otherwise..

[andrewtavis]

Here we need SPARQLWrapper : the context. as that's the return value for this function.

[andrewtavis]

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]

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

[andrewtavis]

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.

[Jk40git]

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)?