Corrected code examples in topics docs. #19697
Conversation
There was a problem hiding this comment.
Hello! Thank you for your contribution 💪
As it's your first contribution be sure to check out the patch review checklist.
If you're fixing a ticket from Trac make sure to set the "Has patch" flag and include a link to this PR in the ticket!
If you have any design or process questions then you can ask in the Django forum.
Welcome aboard ⛵️!
| @@ -275,6 +275,7 @@ function decorator into a method decorator so that it can be used on an | |||
| instance method. For example:: | |||
|
|
|||
| from django.contrib.auth.decorators import login_required | |||
| from django.views.decorators.cache import never_cache | |||
There was a problem hiding this comment.
| from django.views.decorators.cache import never_cache |
I would drop this, it's not needed for the initial example and for the example
We could add it to the example lower down but I think the concept it is showing is clear enough without the import
There was a problem hiding this comment.
I agree that the concept is clear, but adding the import could help beginners avoid confusion when copy-pasting the example. Thanks for the suggestions, I've made the other corrections you suggested, happy to leave the import out if you prefer.
This PR corrects few minor issues in the Django topic guides:
requestinstead ofself.requestin theJsonableResponseMixin example.
These changes improve the accuracy of the documentation examples, ensuring
They can be copied and run without errors.