Opened 3 years ago

Closed 9 months ago

Last modified 9 months ago

#21516 closed Cleanup/optimization (fixed)

Update the import path for the FormSet classes and factories in documentation.

Reported by: loic84 Owned by: bxm156
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: yes UI/UX: no

Description

Since #21489, FormSet classes and factories are exposed directly on the django.forms package.

Examples in the docs should be updated to reflect this change at some point. The docs update is delayed for a couple of releases to help people who misuse the dev docs with an earlier version of Django so they don't get confusing import errors.

The original ticket (#21489) has a tentative patch and discussions relevant to this ticket.

Change History (10)

comment:1 Changed 3 years ago by loic84

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Someday/Maybe

comment:2 Changed 9 months ago by timgraham

  • Easy pickings set
  • Triage Stage changed from Someday/Maybe to Accepted

This change was made in Django 1.7 and all older versions are now unsupported so it seems like a good time to make the change. See 1c7a83ee8e3da431d9d21dae42da8f1f89973f7c for the functions and classes to update.

comment:3 Changed 9 months ago by bxm156

  • Owner changed from nobody to bxm156
  • Status changed from new to assigned

comment:4 Changed 9 months ago by bxm156

This is my first ticket / contribution to the Django project.

I have created a topic branch at:
https://github.com/bxm156/django/tree/ticket_21516

Commit:
https://github.com/bxm156/django/commit/9c117b9bd62ea090f1d8b4d7fb7345ebaaf9e836

Ran make html in docs locally, the build succeeded.

comment:5 Changed 9 months ago by charettes

  • Has patch set

comment:6 Changed 9 months ago by timgraham

  • Patch needs improvement set

comment:7 Changed 9 months ago by bxm156

I have updated my changes to reflect timgraham's feedback.

https://github.com/django/django/pull/5492

comment:8 Changed 9 months ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from assigned to closed

In 455034d4:

Fixed #21516 -- Updated imports paths for some formset functions/classes.

Since refs #21489, FormSet classes and factories are exposed on the
django.forms package.

comment:9 Changed 9 months ago by Tim Graham <timograham@…>

In 44f177b5:

[1.9.x] Fixed #21516 -- Updated imports paths for some formset functions/classes.

Since refs #21489, FormSet classes and factories are exposed on the
django.forms package.

Backport of 455034d4df048010de4ae0a9a2392b70d1463c61 from master

comment:10 Changed 9 months ago by Tim Graham <timograham@…>

In 42f25467:

[1.8.x] Fixed #21516 -- Updated imports paths for some formset functions/classes.

Since refs #21489, FormSet classes and factories are exposed on the
django.forms package.

Backport of 455034d4df048010de4ae0a9a2392b70d1463c61 from master

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