Skip to content

docs: Fix example in errors.md#3694

Merged
patrick91 merged 1 commit intostrawberry-graphql:mainfrom
bricker:patch-3
Nov 12, 2024
Merged

docs: Fix example in errors.md#3694
patrick91 merged 1 commit intostrawberry-graphql:mainfrom
bricker:patch-3

Conversation

@bricker
Copy link
Copy Markdown
Contributor

@bricker bricker commented Nov 11, 2024

Description

Fixes one of the examples in the "Dealing with errors" documentation. The example RegisterUserSuccess type has a single property user, which was missing in the example field selection.

Types of Changes

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

Issues Fixed or Closed by This PR

n/a

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

Documentation:

  • Corrected the example in the 'Dealing with errors' documentation by adding the missing 'user' property in the 'RegisterUserSuccess' type field selection.

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Nov 11, 2024

Reviewer's Guide by Sourcery

This PR fixes a documentation error in the GraphQL mutation example within the errors guide. The change corrects the field selection for the RegisterUserSuccess type by properly nesting the id and username fields under the user property.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated GraphQL mutation example to correctly show nested field selection
  • Added missing user field wrapper in the RegisterUserSuccess type
  • Moved id and username fields to be nested under the user property
docs/guides/errors.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
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 @bricker - I've reviewed your changes and they look great!

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 and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown
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.

oh, well spotted! thank you so much!

@patrick91 patrick91 merged commit 37eb716 into strawberry-graphql:main Nov 12, 2024
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.

2 participants