Opened 13 years ago

Closed 9 years ago

#14748 closed Bug (invalid)

Missing documentation for FormPreview methods

Reported by: Honza Král Owned by: jorgecarleitao
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

The FormPreview class has a lot of methods that enable user's to modify it's default behavior. Most of these methods are not documented.

http://docs.djangoproject.com/en/dev/ref/contrib/formtools/form-preview/#advanced-formpreview-methods

Change History (7)

comment:1 by Gabriel Hurley, 13 years ago

Triage Stage: UnreviewedAccepted

There are a number of problems with the docs for FormPreview...

  1. They're badly organized. All the attribute and method reference documentation for FormPreview should live together under http://docs.djangoproject.com/en/dev/ref/contrib/formtools/form-preview/#django.contrib.formtools.FormPreview rather than being spread across that section and "advanced methods".
  1. Important methods which explicitly (in the code) are marked as "METHODS SUBCLASSES MIGHT OVERRIDE IF APPROPRIATE" are not documented at all.
  1. The crossref targets for the FormPreview class are all wrong. They are currently pointed at django.contrib.formtools.FormPreview when they should be pointed at django.contrib.formtools.preview.FormPreview. I assume this is either a lack of indentation or a lack of a currentmodule directive.

comment:2 by anonymous, 13 years ago

milestone: 1.3
Severity: Normal
Type: Bug

comment:3 by Aymeric Augustin, 12 years ago

UI/UX: unset

Change UI/UX from NULL to False.

comment:4 by Aymeric Augustin, 12 years ago

Easy pickings: unset

Change Easy pickings from NULL to False.

comment:5 by Tim Graham, 10 years ago

Summary: Missing docummentation for FormPreview methodsMissing documentation for FormPreview methods

comment:6 by jorgecarleitao, 10 years ago

Owner: changed from nobody to jorgecarleitao
Status: newassigned

comment:7 by Tim Graham, 9 years ago

Resolution: invalid
Status: assignedclosed
Note: See TracTickets for help on using tickets.
Back to Top