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 typo fix #3747

Merged
merged 1 commit into from
Jan 5, 2025
Merged

Conversation

bricker
Copy link
Contributor

@bricker bricker commented Jan 4, 2025

minor typo fix in documentation

Summary by Sourcery

Documentation:

  • Fix typo in GlobalID scalar definition.

Copy link
Contributor

sourcery-ai bot commented Jan 4, 2025

Reviewer's Guide by Sourcery

This pull request fixes a typo in the documentation for the strawberry.schema.types.scalar module. The typo was in a comment that explained why the GlobalID class cannot be wrapped with the @scalar decorator.

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

File-Level Changes

Change Details Files
Fixed typo in comment explaining why GlobalID cannot be wrapped with @scalar
  • Corrected the spelling of "GLobalID" to "GlobalID" in the comment explaining why the GlobalID class cannot be wrapped with the @scalar decorator.
strawberry/schema/types/scalar.py

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
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.

@botberry
Copy link
Member

botberry commented Jan 4, 2025

Hi, thanks for contributing to Strawberry 🍓!

We noticed that this PR is missing a RELEASE.md file. We use that to automatically do releases here on GitHub and, most importantly, to PyPI!

So as soon as this PR is merged, a release will be made 🚀.

Here's an example of RELEASE.md:

Release type: patch

Description of the changes, ideally with some examples, if adding a new feature.

Release type can be one of patch, minor or major. We use semver, so make sure to pick the appropriate type. If in doubt feel free to ask :)

Here's the tweet text:

🆕 Release (next) is out! Thanks to Bryan Ricker for the PR 👏

Get it here 👉 https://strawberry.rocks/release/(next)

Copy link

codecov bot commented Jan 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.28%. Comparing base (6bc7332) to head (743fdac).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3747   +/-   ##
=======================================
  Coverage   97.28%   97.28%           
=======================================
  Files         502      502           
  Lines       33375    33375           
  Branches     5477     5477           
=======================================
  Hits        32469    32469           
  Misses        697      697           
  Partials      209      209           

Copy link

codspeed-hq bot commented Jan 4, 2025

CodSpeed Performance Report

Merging #3747 will not alter performance

Comparing bricker:patch-4 (743fdac) with main (6bc7332)

Summary

✅ 21 untouched benchmarks

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.

Thank you!

@patrick91 patrick91 merged commit bf386fa into strawberry-graphql:main Jan 5, 2025
92 of 93 checks passed
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