Opened 11 months ago

Closed 10 months ago

Last modified 10 months ago

#22809 closed Cleanup/optimization (fixed)

Refactor model field references

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

Description

At the moment, the API references of the model Field are scattered in docs/howto/custom-model-field.txt and docs/ref/models/fields.txt.

I propose to move all the references to docs/ref/models/fields.txt and keep the howto part of the documentation more focused on the subject, e.g. avoiding defining

.. method:: Field.get_prep_value(value)

there.

Change History (10)

comment:1 Changed 11 months ago by timo

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

Yes, probably at the bottom of the page in their own section sounds good.

comment:2 Changed 11 months ago by jorgecarleitao

  • Has patch set

Pull request: https://github.com/django/django/pull/2796

Both sections of the docs still require a major editorial process on wording and references to models,
either to be addressed in this ticket or another.

comment:3 Changed 11 months ago by timo

  • Patch needs improvement set

Please uncheck "Patch needs improvement" when you want me to review it.

comment:4 Changed 11 months ago by jorgecarleitao

  • Patch needs improvement unset

comment:5 Changed 11 months ago by timo

  • Patch needs improvement set

Reviewed.

comment:6 Changed 10 months ago by jorgecarleitao

  • Patch needs improvement unset
  • Status changed from new to assigned

comment:7 Changed 10 months ago by timo

  • Patch needs improvement set

Still has some problems and doesn't merge cleanly.

comment:8 Changed 10 months ago by jorgecarleitao

  • Patch needs improvement unset

Fixed the problems and rebased against master.

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

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

In e1fa7dffdc1b141cb858160890d448ca778366e4:

Fixed #22809 -- Added model Field API reference.

Thanks to @timgraham for the review.

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

In bddea532f76dd59b54aede74fc7aac0d535b367b:

[1.7.x] Fixed #22809 -- Added model Field API reference.

Thanks to @timgraham for the review.

Backport of e1fa7dffdc from master

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