Skip to content
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

Implement check_docstring function for SPARQL docstring validation #489

Merged
merged 3 commits into from
Oct 26, 2024

Conversation

OmarAI2003
Copy link
Contributor

Contributor checklist


Description

  1. Docstring Validation Function

    • Added a new check_docstring() function that validates the docstrings in SPARQL query files.
    • Incorporated check_docstring() into the main validation process for automated checking.
  2. SPARQL Query File Fixes

    • Updated SPARQL query files based on the diagnostic results from the check_docstring() function.
    • Added a new SPARQL query file specifically for Bokmål adverbs.

Testing

  • Ran the main validation function check_query_forms in the terminal py path to check_query_forms.py .
  • Ran pytest.

Related issue

- Created check_docstring to verify docstring format using regex.
- Integrated it into the main validation process to report errors.
Copy link

github-actions bot commented Oct 26, 2024

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. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

  • The linting and formatting workflow within the PR checks do not indicate new errors in the files changed

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

- Corrected docstring formatting issues in diagnosed SPARQL query files.
- Created a new SPARQL query file for Bokmål adverbs.(bonus)
@andrewtavis andrewtavis added the hacktoberfest-accepted Accepted as a part of Hacktoberfest label Oct 26, 2024
@andrewtavis andrewtavis self-requested a review October 26, 2024 21:51
Copy link
Member

@andrewtavis andrewtavis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really thanks a lot for all of the checks here, @OmarAI2003 :) This is working great!

@andrewtavis andrewtavis merged commit 40c41ab into scribe-org:main Oct 26, 2024
7 checks passed
@OmarAI2003 OmarAI2003 deleted the check-docstring-format branch October 27, 2024 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Accepted as a part of Hacktoberfest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants