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

Add API documentation for set_original_claim #1944

Merged
merged 2 commits into from
Jul 9, 2024

Conversation

jayjay-w
Copy link
Contributor

@jayjay-w jayjay-w commented Jul 5, 2024

Description

Add API documentation for set_original_claim in the createProjectMedia mutation.

References: CV2-4676

How has this been tested?

Confirmed that the changes are well formatted and the query example works.

Checklist

  • I have performed a self-review of my own code
  • I have added unit and feature tests, if the PR implements a new feature or otherwise would benefit from additional testing
  • I have added regression tests, if the PR fixes a bug
  • I have added logging, exception reporting, and custom tracing with any additional information required for debugging
  • I considered secure coding practices when writing this code. Any security concerns are noted above.
  • I have commented my code in hard-to-understand areas, if any
  • I have made needed changes to the README
  • My changes generate no new warnings
  • If I added a third party module, I included a rationale for doing so and followed our current guidelines

@caiosba
Copy link
Contributor

caiosba commented Jul 5, 2024

Thanks @jayjay-w , and please remember to update the documentation here too: https://github.com/meedan/check/wiki/GraphQL-query-examples#create-fact-check

Add API documentation for `set_original_claim` in the `createProjectMedia` mutation.
@jayjay-w jayjay-w requested a review from vasconsaurus July 6, 2024 21:16
@jayjay-w jayjay-w self-assigned this Jul 6, 2024
@jayjay-w jayjay-w marked this pull request as ready for review July 6, 2024 21:17
@vasconsaurus
Copy link
Contributor

I have a tiny nitpick/suggestion, feel free to ignore it.
I would change line 272 so that the heading is in the same hierarchy as the Create medias (

### Create original claim when creating media
)

## Create media with original claim


Seemingly unrelated to this PR, but in this link: https://github.com/meedan/check/wiki/GraphQL-query-examples#create-fact-check

I would move Create original claim when creating fact check to the Create fact-check section. And add it as a last item there, Create a fact-check with an original claim, instead of leaving it under Update a fact-check.

Screenshot 2024-07-08 at 08 44 15

@jayjay-w jayjay-w force-pushed the CV2-4676-add-api-documentation-for-original-claim branch from 8bbfb88 to fc2ec51 Compare July 9, 2024 11:41
@jayjay-w
Copy link
Contributor Author

jayjay-w commented Jul 9, 2024

@vasconsaurus this is ready for your re-review.


Regarding, https://github.com/meedan/check/wiki/GraphQL-query-examples#create-original-claim-when-creating-fact-check, I updated it directly and now it should be in the correct section.

@vasconsaurus
Copy link
Contributor

Thanks @jayjay-w! Looks great 🚀

@jayjay-w jayjay-w merged commit 4452383 into master Jul 9, 2024
7 checks passed
@caiosba
Copy link
Contributor

caiosba commented Jul 9, 2024

@jayjay-w we need this in develop (no need to revert the merge to master though)

jayjay-w added a commit that referenced this pull request Jul 15, 2024
* Add API documentation for `set_original_claim`

Add API documentation for `set_original_claim` in the `createProjectMedia` mutation.

* Adress reviewer feedback
@jayjay-w jayjay-w deleted the CV2-4676-add-api-documentation-for-original-claim branch October 6, 2024 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants