Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#23239 closed Bug (fixed)

missleading info concerning contrib.markup

Reported by: anonymous Owned by: nobody
Component: Documentation Version: 1.4
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

regards documentation of django.contrib.markup for django 1.3, 1.4 and 1.5 as found under https://docs.djangoproject.com/en/1.3/ref/contrib/markup/

the pages section regarding the useage of the 'markdown filter tag" and its safety states:
"To enable both options [ “safe_mode” and “enable_attributes”] in tandem, the markdown filter supports the “safe” argument."

as "enable" will most likly be understood as "set to true" the sentence above is false. using the "safe" argument will lead to <enable_attributes=False> (which is the safe setting however).

possible rephrasing:
"The Python Markdown library supports options named “safe_mode” and “enable_attributes”. Both relate to the security of the output. To use the safety-settings of both options in tandem, the markdown filter supports the “safe” argument."

Change History (2)

comment:1 by Tim Graham <timograham@…>, 10 years ago

Resolution: fixed
Status: newclosed

In e0fb48c2548c05b010c3b8d64f5906b092b0b503:

[1.5.x] Fixed #23239 -- Clarified a phrase in the contrib.markup docs.

comment:2 by Tim Graham <timograham@…>, 10 years ago

In d23d19c15eb816cc0c7ff1831fee050779db9873:

[1.4.x] Fixed #23239 -- Clarified a phrase in the contrib.markup docs.

Backport of e0fb48c254 from stable/1.5.x

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