Code

Opened 4 years ago

Last modified 13 days ago

#14748 new Bug

Missing documentation for FormPreview methods

Reported by: Honza_Kral Owned by: nobody
Component: Documentation Version: master
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

Attachments (0)

Change History (5)

comment:1 Changed 4 years ago by gabrielhurley

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

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 Changed 3 years ago by anonymous

  • milestone 1.3 deleted
  • Severity set to Normal
  • Type set to Bug

comment:3 Changed 2 years ago by aaugustin

  • UI/UX unset

Change UI/UX from NULL to False.

comment:4 Changed 2 years ago by aaugustin

  • Easy pickings unset

Change Easy pickings from NULL to False.

comment:5 Changed 13 days ago by timo

  • Summary changed from Missing docummentation for FormPreview methods to Missing documentation for FormPreview methods

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as new
The owner will be changed from nobody to anonymous. Next status will be 'assigned'
as The resolution will be set. Next status will be 'closed'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.