-
-
Notifications
You must be signed in to change notification settings - Fork 538
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
Make clear the requirement of the [cli] dependency group for the schema exporter #3728
Conversation
Make clear the requirement of the [cli] dependency group.
Reviewer's Guide by SourceryThis PR updates the schema export documentation to clarify that the CLI dependency group is required for using the schema exporter functionality. The change is straightforward, adding a single informative line to the existing documentation. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
for more information, see https://pre-commit.ci
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @shaggyz - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
docs/guides/schema-export.md
Outdated
@@ -10,6 +10,8 @@ schema definition. | |||
Strawberry provides a command to export your schema definition. The exported | |||
schema will be described in the GraphQL schema definition language (SDL). | |||
|
|||
To use the command line tools, you have to ensure Strawberry was installed with `strawberry-graphql[cli]`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion: Consider adding the specific pip install command for clarity
It would be helpful to include the actual pip install command (e.g., pip install 'strawberry-graphql[cli]'
) to make it even easier for users to get started.
To use the command line tools, you have to ensure Strawberry was installed with `strawberry-graphql[cli]`. | |
To use the command line tools, you have to ensure Strawberry was installed with the CLI extras: | |
```bash | |
pip install 'strawberry-graphql[cli]' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Thanks for contributing to Strawberry! 🎉 You've been invited to join 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 🔥 |
Description
Make clear the requirement of the [cli] dependency group when running the schema exporter to avoid import module errors.
Types of Changes
Issues Fixed or Closed by This PR
Not closed, but related to: #3056
Checklist
Summary by Sourcery
Documentation: