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

docs: Remove mention about having to enable subscriptions in the docs #645

Merged
merged 1 commit into from
Oct 19, 2024

Conversation

bellini666
Copy link
Member

@bellini666 bellini666 commented Oct 19, 2024

The subscriptions feature is now enabled by default.

Not only that, but the keyword to enable it got removed in https://github.com/strawberry-graphql/strawberry/releases/tag/0.245.0

Fix #644

Summary by Sourcery

Documentation:

  • Remove outdated instructions for enabling subscriptions in the documentation.

@bellini666 bellini666 self-assigned this Oct 19, 2024
Copy link
Contributor

sourcery-ai bot commented Oct 19, 2024

Reviewer's Guide by Sourcery

This pull request removes outdated information from the documentation regarding the need to enable subscriptions, as the feature is now enabled by default.

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

File-Level Changes

Change Details Files
Remove instructions for enabling subscriptions in Django URLs
  • Delete code snippet showing how to enable subscriptions in AsgiGraphQLView
  • Remove explanation about enabling subscriptions in MyProject.urls.py
docs/guide/subscriptions.md

Possibly linked issues


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 @bellini666 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a brief note mentioning that subscriptions are now enabled by default, to provide context for the removal of this section and help users upgrading from older versions.
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: 2 issues 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.

docs/guide/subscriptions.md Outdated Show resolved Hide resolved
docs/guide/subscriptions.md Outdated Show resolved Hide resolved
@codecov-commenter
Copy link

codecov-commenter commented Oct 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.71%. Comparing base (5ff6250) to head (5c2b20c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #645   +/-   ##
=======================================
  Coverage   88.71%   88.71%           
=======================================
  Files          41       41           
  Lines        3606     3606           
=======================================
  Hits         3199     3199           
  Misses        407      407           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

The subscriptions feature is now enabled by default.

Not only that, but the keyword to enable it got removed in
https://github.com/strawberry-graphql/strawberry/releases/tag/0.245.0
@bellini666 bellini666 merged commit 0a07d8e into main Oct 19, 2024
24 checks passed
@bellini666 bellini666 deleted the fix_subscriptions_docs branch October 19, 2024 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants