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

Fix minor typo in relay guide docs #3586

Merged

Conversation

rapsealk
Copy link
Contributor

@rapsealk rapsealk commented Aug 4, 2024

Hello strawberry team!

This pull request fixes a very very minor typo in relay.mdx docs.

Thanks for your review in advance!

Description

Before

It can be defined **in in** the `Query` objects in 4 ways:

After

It can be defined **in** the `Query` objects in 4 ways:

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

Summary by Sourcery

Fix a minor typo in the relay guide documentation.

Documentation:

  • Correct a minor typo in the relay guide documentation, changing 'in in' to 'in'.

Copy link
Contributor

sourcery-ai bot commented Aug 4, 2024

Reviewer's Guide by Sourcery

This pull request addresses a minor typo in the relay guide documentation by removing a duplicate word. Additionally, a release note has been added to document this change.

File-Level Changes

Files Changes
docs/guides/relay.mdx
RELEASE.md
Fixed a minor typo in the relay guide documentation and added a corresponding release note.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @rapsealk - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Thank you for fixing the typo in the documentation. For future reference, adding a RELEASE.md file is typically not necessary for minor documentation changes. Consider omitting this file for similar contributions in the future.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

Copy link
Member

@patrick91 patrick91 left a comment

Choose a reason for hiding this comment

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

Very cool! Thanks 😊

@patrick91 patrick91 merged commit f4ecb67 into strawberry-graphql:main Aug 4, 2024
3 checks passed
@botberry
Copy link
Member

botberry commented Aug 4, 2024

Thanks for contributing to Strawberry! 🎉 You've been invited to join
the Strawberry GraphQL organisation 😊

You can also request a free sticker by filling this form: https://forms.gle/dmnfQUPoY5gZbVT67

And don't forget to join our discord server: https://strawberry.rocks/discord 🔥

@rapsealk rapsealk deleted the docs/typo-in-relay-guide branch August 5, 2024 10:30
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