Opened 11 months ago

Closed 10 months ago

Last modified 10 months ago

#35441 closed Cleanup/optimization (fixed)

Context autoescape parameter is not documented

Reported by: Roman Donchenko Owned by: John Higgins
Component: Template system Version: 5.0
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

In #35296 I was advised to use the autoescape parameter of the Context constructor. However, it is not documented. The ​reference for Context only mentions the dict_ parameter.

If this parameter is part of the public API, it should be documented.

Change History (12)

comment:1 by Natalia Bidart, 11 months ago

Component: Documentation → Template system
Triage Stage: Unreviewed → Accepted
Type: Bug → Cleanup/optimization

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!

comment:2 by John Higgins, 11 months ago

Owner: changed from nobody to John Higgins
Status: new → assigned

I'll write some docs for this!

comment:3 by John Higgins, 11 months ago

Has patch: set

comment:4 by John Higgins, 11 months ago

Here's a link to the patch: ​https://github.com/django/django/pull/18161

Last edited 11 months ago by John Higgins (previous) (diff)

comment:5 by Mariusz Felisiak, 11 months ago

Patch needs improvement: set

comment:6 by John Higgins, 11 months ago

Patch needs improvement: unset

comment:7 by John Higgins, 11 months ago

This has a patch ready for review if anyone wants to review it.

comment:8 by Sarah Boyce, 10 months ago

Patch needs improvement: set

comment:9 by John Higgins, 10 months ago

Patch needs improvement: unset

comment:10 by Sarah Boyce, 10 months ago

Triage Stage: Accepted → Ready for checkin

comment:11 by Sarah Boyce <42296566+sarahboyce@…>, 10 months ago

Resolution: → fixed
Status: assigned → closed

In 60acad93:

Fixed #35441 -- Documented Context and RequestContext keyword arguments.

comment:12 by Sarah Boyce <42296566+sarahboyce@…>, 10 months ago

In 874fea6:

[5.1.x] Fixed #35441 -- Documented Context and RequestContext keyword arguments.

Backport of 60acad933d66e116c89150d3eb9040f62ca871a1 from main.

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