Skip to content

Updated schema-configurations.md to correct the last code example #3651

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

Merged

Conversation

topher-g
Copy link
Contributor

@topher-g topher-g commented Sep 28, 2024

Description

Updated schema-configurations.md to correct the following code example:

class CustomInfo(Info):
    @property
    def response_headers(self) -> Headers:
        return self.context["response"].headers


schema = strawberry.Schema(query=Query, info_class=CustomInfo)

to correctly use StrawberryConfig as follows:

class CustomInfo(Info):
    @property
    def response_headers(self) -> Headers:
        return self.context["response"].headers


schema = strawberry.Schema(query=Query, config=StrawberryConfig(info_class=CustomInfo))

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

Update the schema-configurations.md documentation to correct the code example by using StrawberryConfig for the info_class parameter.

Documentation:

  • Correct the code example in schema-configurations.md to use StrawberryConfig for specifying the info_class.

Copy link
Contributor

sourcery-ai bot commented Sep 28, 2024

Reviewer's Guide by Sourcery

This pull request updates the documentation in the schema-configurations.md file to correct a code example. The change demonstrates the proper use of StrawberryConfig when configuring a custom Info class in a Strawberry schema.

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

File-Level Changes

Change Details Files
Updated code example to use StrawberryConfig for configuring custom Info class
  • Replaced direct assignment of info_class with StrawberryConfig
  • Added config parameter to strawberry.Schema constructor
  • Wrapped CustomInfo class in StrawberryConfig
docs/types/schema-configurations.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.

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
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 @topher-g - 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: 1 issue found

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.

@patrick91 patrick91 merged commit 36bd99e into strawberry-graphql:main Sep 28, 2024
3 checks passed
@botberry
Copy link
Member

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 🔥

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