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 Django permissions diagram syntax #663

Merged

Conversation

sersorrel
Copy link
Contributor

@sersorrel sersorrel commented Nov 28, 2024

Description

The Django permissions docs have a syntax error which breaks the diagram slightly:

image

so, we take the same approach as the "Return an empty relay 'Connection'" box just below and simply remove the unsupported syntax.

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

Documentation:

  • Correct the syntax error in the Django permissions diagram by removing unsupported syntax.

Copy link
Contributor

sourcery-ai bot commented Nov 28, 2024

Reviewer's Guide by Sourcery

This PR fixes a syntax error in the Django permissions documentation diagram by removing backticks around the word 'Connection' to maintain consistency with other diagram elements and prevent rendering issues.

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

File-Level Changes

Change Details Files
Updated Mermaid diagram syntax in Django permissions documentation
  • Removed backticks around 'Connection' in the diagram flow text
  • Aligned syntax with existing diagram elements for consistency
docs/guide/permissions.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
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 @sersorrel - 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.

@patrick91
Copy link
Member

thank you!

@patrick91 patrick91 merged commit a0c6ab0 into strawberry-graphql:main Nov 28, 2024
21 of 22 checks passed
@sersorrel sersorrel deleted the fix-django-permissions-diagram branch November 28, 2024 17:54
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