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

Documentation for how to write Scribe-Data queries #412

Merged
merged 3 commits into from
Oct 19, 2024

Conversation

OkpePhillips
Copy link
Contributor

Contributor checklist


Description

This PR adds a new documentation file SPARQL_QUERY_WRITING.md to the project in src/scribe_data/wikidata directory and details how to find forms for Wikidata lexemes and outlines the best practices for how to write Wikidata queries for use in Scribe-Data.

The documentation is generally based on the explanation by @andrewtavis on the project's chat platform.

Related issue

… retrieve all forms associated with a lexical category in a specified language
Copy link

github-actions bot commented Oct 18, 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)

@OkpePhillips
Copy link
Contributor Author

@KesharwaniArpita and @Aeeshah1 you can now review the documentation and let me know your thoughts.
Thanks
cc: @andrewtavis

@andrewtavis andrewtavis added the hacktoberfest-accepted Accepted as a part of Hacktoberfest label Oct 18, 2024
@andrewtavis andrewtavis self-requested a review October 18, 2024 08:27
@andrewtavis
Copy link
Member

Amazing @OkpePhillips! One thing I was thinking about this, let's remember to also link the Wikidata guide we have as a community :) If you can think of a good spot at the top, then add it by all means, or I'll also look into it in my review 😊

@OkpePhillips
Copy link
Contributor Author

Thank you @KesharwaniArpita for the suggestion. It has been committed.

Thanks @andrewtavis for your guidance always.

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 amazing work, @OkpePhillips, and thanks for the suggestion, @KesharwaniArpita :) Lots of further work went into this as I really wanted to make sure that this has everything we need. I also switched from Slovak to Spanish so the example is a bit easier.

Some minor notes:

  • Try to keep docs clean by not including ---
    • The lines of headers are all we need
  • Honestly this was the only main thing - great work!

@andrewtavis andrewtavis merged commit cd5f5c9 into scribe-org:main Oct 19, 2024
5 checks passed
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.

3 participants