Opened 6 years ago

Closed 6 years ago

#29524 closed Cleanup/optimization (worksforme)

Documentation Error

Reported by: Jayakrishna Sahit Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords: documentation, HttpRequest, request
Cc: Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: yes

Description (last modified by Jayakrishna Sahit )

I believe that the HttpRequest Object has been represented wrongly. The class object and its attributes point to the object HttpRequest object but are however for the request object. This error is present in all version documentation.
https://code.djangoproject.com/attachment/ticket/29524/Screen%20Shot%202018-06-25%20at%2010.10.14%20PM.png
https://code.djangoproject.com/attachment/ticket/29524/Screen%20Shot%202018-06-25%20at%2010.10.31%20PM.png

Possible Fix
Either making clear that the HttpRequest object being referred to is actually the request object or changing all the HttpRequest text to request.

Attachments (2)

Screen Shot 2018-06-25 at 10.10.14 PM.png​ (75.2 KB ) - added by Jayakrishna Sahit 6 years ago.
change in object name
Screen Shot 2018-06-25 at 10.10.31 PM.png​ (80.0 KB ) - added by Jayakrishna Sahit 6 years ago.
change in object name

Download all attachments as: .zip

Change History (4)

by Jayakrishna Sahit , 6 years ago

Attachment: Screen Shot 2018-06-25 at 10.10.14 PM.png​ added

change in object name

by Jayakrishna Sahit , 6 years ago

Attachment: Screen Shot 2018-06-25 at 10.10.31 PM.png​ added

change in object name

comment:1 by Jayakrishna Sahit , 6 years ago

Description: modified (diff)

comment:2 by Tim Graham, 6 years ago

Resolution: → worksforme
Status: new → closed

I think most people reading these examples should understand the convention of using the variable name request to refer to an HttpRequest.

Note: See TracTickets for help on using tickets.
Back to Top