[Django] #35441: Context autoescape parameter is not documented

[Django]

#35441: Context autoescape parameter is not documented
-------------------------------------------+------------------------
Reporter: Roman Donchenko | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 5.0
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------------+------------------------
In #35296 I was advised to use the `autoescape` parameter of the `Context`
constructor. However, it is not documented. The
[https://docs.djangoproject.com/en/5.0/ref/templates/api/#django.template.Context
reference for Context] only mentions the `dict_` parameter.

If this parameter is part of the public API, it should be documented.
--
Ticket URL: <https://code.djangoproject.com/ticket/35441>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#35441: Context autoescape parameter is not documented

--------------------------------------+------------------------------------

Reporter: Roman Donchenko | Owner: nobody

Type: Cleanup/optimization | Status: new
Component: Template system | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

--------------------------------------+------------------------------------
Changes (by Natalia Bidart):

* component: Documentation => Template system
* stage: Unreviewed => Accepted
* type: Bug => Cleanup/optimization

Comment:

Hello Roman,

I have followed the docs and pointers you provided and I think you are
right, the `Context` docs could use some improving. Would you be willing
to help making a patch? Thank you!
--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:1>

[Django]

#35441: Context autoescape parameter is not documented

-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: John
Type: | Higgins
Cleanup/optimization | Status: assigned

Component: Template system | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by John Higgins):

* owner: nobody => John Higgins
* status: new => assigned

Comment:

I'll write some docs for this!
--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:2>

[Django]

#35441: Context autoescape parameter is not documented
-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: John
Type: | Higgins
Cleanup/optimization | Status: assigned
Component: Template system | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by John Higgins):

* has_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:3>

[Django]

#35441: Context autoescape parameter is not documented
-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: John
Type: | Higgins
Cleanup/optimization | Status: assigned
Component: Template system | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by John Higgins):

Here's a link to the patch:
https://github.com/django/django/pull/18161/files
--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:4>

[Django]

#35441: Context autoescape parameter is not documented
-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: John
Type: | Higgins
Cleanup/optimization | Status: assigned
Component: Template system | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mariusz Felisiak):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:5>

[Django]

#35441: Context autoescape parameter is not documented
-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: John
Type: | Higgins
Cleanup/optimization | Status: assigned
Component: Template system | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by John Higgins):

* needs_better_patch: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:6>

[Django]

#35441: Context autoescape parameter is not documented
-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: John
Type: | Higgins
Cleanup/optimization | Status: assigned
Component: Template system | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by John Higgins):

This has a patch ready for review if anyone wants to review it.
--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:7>

[Django]

#35441: Context autoescape parameter is not documented
-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: John
Type: | Higgins
Cleanup/optimization | Status: assigned
Component: Template system | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:8>

[Django]

#35441: Context autoescape parameter is not documented
-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: John
Type: | Higgins
Cleanup/optimization | Status: assigned
Component: Template system | Version: 5.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by John Higgins):

* needs_better_patch: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:9>

[Django]

#35441: Context autoescape parameter is not documented
-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: John
Type: | Higgins
Cleanup/optimization | Status: assigned
Component: Template system | Version: 5.0
Severity: Normal | Resolution:

Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce):

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:10>

[Django]

#35441: Context autoescape parameter is not documented
-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: John
Type: | Higgins

Cleanup/optimization | Status: closed

Component: Template system | Version: 5.0

Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Sarah Boyce <42296566+sarahboyce@…>):

* resolution: => fixed
* status: assigned => closed

Comment:

In [changeset:"60acad933d66e116c89150d3eb9040f62ca871a1" 60acad93]:
{{{#!CommitTicketReference repository=""
revision="60acad933d66e116c89150d3eb9040f62ca871a1"
Fixed #35441 -- Documented Context and RequestContext keyword arguments.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:11>

[Django]

#35441: Context autoescape parameter is not documented
-------------------------------------+-------------------------------------
Reporter: Roman Donchenko | Owner: John
Type: | Higgins
Cleanup/optimization | Status: closed
Component: Template system | Version: 5.0
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Sarah Boyce <42296566+sarahboyce@…>):

In [changeset:"874fea63b477851d5902200ab3f7ed139c1c9cd2" 874fea6]:
{{{#!CommitTicketReference repository=""
revision="874fea63b477851d5902200ab3f7ed139c1c9cd2"
[5.1.x] Fixed #35441 -- Documented Context and RequestContext keyword
arguments.

Backport of 60acad933d66e116c89150d3eb9040f62ca871a1 from main.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/35441#comment:12>