Update README.md #3679
Open
Update README.md #3679
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's Guide by SourceryThis PR updates the README.md file to improve documentation clarity and usability. The changes include reorganizing content, adding comprehensive testing examples, and enhancing code snippets to be directly executable. The documentation has been restructured with better section organization and more detailed explanations of features. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
for more information, see https://pre-commit.ci
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @HmbleCreator - I've reviewed your changes - here's some feedback:
Overall Comments:
- The PR checklist indicates tests haven't been added, but this is marked as required. Either add relevant tests or update the checklist to indicate tests aren't needed for documentation changes.
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
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
for more information, see https://pre-commit.ci
I've reorganized the README with the testing section now featuring three separate, clearly labeled code snippets for different HTTP clients: A section for httpx, showing basic query testing A section for requests, demonstrating testing with variables A section for aiohttp, showing async testing capabilities Each section is self-contained with its own imports and example usage. The rest of the README remains unchanged, maintaining all the other important information about installation, features, development setup, and community resources.
for more information, see https://pre-commit.ci
several formatting improvements to ensure the README passes the pre-commit hooks: Removed all trailing whitespace Properly formatted all code blocks ensuring consistent indentation Fixed GraphQL query formatting to be consistent Removed unnecessary comments and whitespace in the code examples Ensured proper line endings Made sure all Python code follows black formatting guidelines The code examples are now more readable and consistently formatted. Would you like me to explain any of the specific formatting changes or make additional adjustments?
for more information, see https://pre-commit.ci
Key changes made to satisfy Black formatting: Added type hints to __init__ methods Added consistent double line breaks between classes and functions Properly formatted multiline function arguments with trailing commas Consistent indentation for multiline strings Added proper spacing around class definitions Fixed string formatting to match Black's standards Properly formatted imports with spacing
There was a problem hiding this comment.
Hey @HmbleCreator - 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: 3 issues found
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Key improvements in this version: Added MyPy documentation links Added comprehensive test data setup section Updated test examples to use the defined test data Added Discord community information in the Community & Support section Ensured consistent formatting throughout the document Improved code examples with proper type hints and formatting Made the testing section more cohesive with a clear progression
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request updates the README file to ensure that all code snippets can be copied and executed without modifications. The changes enhance clarity and usability for users, providing complete examples and detailed instructions for setting up and using Strawberry GraphQL. Additionally, a new section on testing utilities has been added, along with links to various example projects.
Types of Changes
Issues Fixed or Closed by This PR
Checklist
Summary by Sourcery
Update the README.md to improve documentation clarity and usability by ensuring code snippets are executable as-is, adding a section on testing utilities, and revising installation and setup instructions.
Documentation: