Opened 2 years ago

Closed 2 years ago

Last modified 2 years ago

#35873 closed Cleanup/optimization (fixed)

Example of an invalid call in as_table in form docs.

Reported by: Antoliny Owned by: Antoliny
Component: Documentation Version: 5.0
Severity: Normal Keywords: Forms API Document
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

The Django Forms API document has an invalid example for calling as_table.
Examples of as_div, as_p, and as_ul calls show the appropriate calls and results with print(f.as _xx()) but as_table is print(f), probably a typo of print(f.as_table()).
​as_div example -> print(f.as_div())
​as_p example -> print(f.as_p())
​as_ul example -> print(f.as_ul())
​as_table example -> print(f)

Change History (13)

comment:1 by Antoliny, 2 years ago

Owner: set to Antoliny
Status: new → assigned

comment:2 by Antoliny, 2 years ago

Has patch: set

comment:3 by Antoliny, 2 years ago

​PR

comment:4 by Sarah Boyce, 2 years ago

Summary: Example of an invalid call in as_table. → Example of an invalid call in as_table in form docs.
Triage Stage: Unreviewed → Accepted
Type: Uncategorized → Cleanup/optimization

I think this probably doesn't need a ticket but accepting :)

comment:5 by Antoliny, 2 years ago

Patch needs improvement: set

comment:6 by Antoliny, 2 years ago

Patch needs improvement: unset

comment:7 by Sarah Boyce, 2 years ago

Triage Stage: Accepted → Ready for checkin

comment:8 by Sarah Boyce, 2 years ago

Triage Stage: Ready for checkin → Accepted

On going discussion on the pull request

Last edited 2 years ago by Sarah Boyce (previous) (diff)

comment:9 by Sarah Boyce, 2 years ago

Patch needs improvement: set

comment:10 by Antoliny, 2 years ago

Patch needs improvement: unset

comment:11 by Sarah Boyce, 2 years ago

Triage Stage: Accepted → Ready for checkin

comment:12 by Sarah Boyce <42296566+sarahboyce@…>, 2 years ago

Resolution: → fixed
Status: assigned → closed

In 8f3dee1d:

Fixed #35873 -- Corrected Form.as_table() call in form docs.

comment:13 by Sarah Boyce <42296566+sarahboyce@…>, 2 years ago

In 4915feaa:

[5.1.x] Fixed #35873 -- Corrected Form.as_table() call in form docs.

Backport of 8f3dee1dfdc4242348c6cd6ead1c359cda78c2b5 from main.

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