Revert "Fix typo" #609
Merged
Revert "Fix typo" #609
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
This reverts commit f845a0c.
Reviewer's Guide by SourceryThis pull request reverts a previous commit that fixed a typo in multiple documentation files. The changes primarily involve reverting the formatting of tip, warning, caution, and info blocks in the documentation. File-Level Changes
Tips
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @patrick91 - I've reviewed your changes - here's some feedback:
Overall Comments:
- Could you please explain the reasoning behind reverting the typo fix and changing the syntax for notes, tips, and warnings from
[!NOTE]to![NOTE]? We'd like to understand the motivation for this change and ensure it aligns with the project's documentation standards. - In future pull requests, please provide a more detailed description of the changes and the rationale behind them. This helps reviewers understand the context and purpose of the modifications.
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
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
| > Do not use `queryset.order_by()` directly. Due to `order_by` not being chainable | ||
| > operation, changes applied this way would be overriden later. | ||
|
|
||
| > [!TIP] > `strawberry_django.Ordering` has convenient method `resolve` that can be used to | ||
| > ![TIP] > `strawberry_django.Ordering` has convenient method `resolve` that can be used to |
There was a problem hiding this comment.
issue (documentation): Formatting issue with the > symbol.
The > symbol should be on a new line for consistency.
| @@ -27,7 +27,7 @@ class Fruit2: | |||
| name: str | |||
| ``` | |||
|
|
|||
| > [!TIP] | |||
| > ![TIP] | |||
| > For choices using | |||
| > [Django's TextChoices/IntegerChoices](https://docs.djangoproject.com/en/4.2/ref/models/fields/#enumeration-types) | |||
| > it is recommented using the [django-choices-field](/integrations/choices-field) integration | |||
There was a problem hiding this comment.
issue (documentation): Typo in the word 'recommented'.
The word 'recommented' should be 'recommended'.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #609 +/- ##
=======================================
Coverage 88.84% 88.84%
=======================================
Files 41 41
Lines 3605 3605
=======================================
Hits 3203 3203
Misses 402 402 ☔ View full report in Codecov by Sentry. |
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.
This reverts commit f845a0c.
Description
Types of Changes
Issues Fixed or Closed by This PR
Checklist
Summary by Sourcery
This pull request reverts a previous commit that fixed a typo in multiple documentation files. The changes restore the original state of the documentation by replacing the corrected 'TIP', 'WARNING', 'CAUTION', 'INFO', and 'NOTE' annotations with their previous incorrect forms.