[Django] #22809: Refactor model field references
Django
--------------------------------------+----------------------------
Reporter: jorgecarleitao | Owner: jorgecarleitao
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+----------------------------
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/22809>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: jorgecarleitao | Owner:
Type: | jorgecarleitao
Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by timo):
* needs_better_patch: => 0
* stage: Unreviewed => Accepted
* needs_tests: => 0
* needs_docs: => 0
Comment:
Yes, probably at the bottom of the page in their own section sounds good.
--
Ticket URL: <https://code.djangoproject.com/ticket/22809#comment:1>
Django
Reporter: jorgecarleitao | Owner:
Type: | jorgecarleitao
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by jorgecarleitao):
* has_patch: 0 => 1
Comment:
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/22809#comment:2>
Django
Reporter: jorgecarleitao | Owner:
Type: | jorgecarleitao
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by timo):
* needs_better_patch: 0 => 1
Comment:
Please uncheck "Patch needs improvement" when you want me to review it.
--
Ticket URL: <https://code.djangoproject.com/ticket/22809#comment:3>
Django
Reporter: jorgecarleitao | Owner:
Type: | jorgecarleitao
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by jorgecarleitao):
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/22809#comment:4>
Django
Reporter: jorgecarleitao | Owner:
Type: | jorgecarleitao
Component: Documentation | Version: master
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by timo):
* needs_better_patch: 0 => 1
Comment:
Reviewed.
--
Ticket URL: <https://code.djangoproject.com/ticket/22809#comment:5>
Django
Reporter: jorgecarleitao | Owner:
Type: | jorgecarleitao
Component: Documentation | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by jorgecarleitao):
* status: new => assigned
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/22809#comment:6>
Django
Reporter: jorgecarleitao | Owner:
Type: | jorgecarleitao
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by timo):
* needs_better_patch: 0 => 1
Comment:
Still has some problems and doesn't merge cleanly.
--
Ticket URL: <https://code.djangoproject.com/ticket/22809#comment:7>
Django
Reporter: jorgecarleitao | Owner:
Type: | jorgecarleitao
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by jorgecarleitao):
* needs_better_patch: 1 => 0
Comment:
Fixed the problems and rebased against master.
--
Ticket URL: <https://code.djangoproject.com/ticket/22809#comment:8>
Django
Reporter: jorgecarleitao | Owner:
Type: | jorgecarleitao
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"e1fa7dffdc1b141cb858160890d448ca778366e4"]:
{{{
#!CommitTicketReference repository=""
revision="e1fa7dffdc1b141cb858160890d448ca778366e4"
Fixed #22809 -- Added model Field API reference.
Thanks to @timgraham for the review.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/22809#comment:9>
Django
Reporter: jorgecarleitao | Owner:
Type: | jorgecarleitao
Cleanup/optimization | Status: closed
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"bddea532f76dd59b54aede74fc7aac0d535b367b"]:
{{{
#!CommitTicketReference repository=""
revision="bddea532f76dd59b54aede74fc7aac0d535b367b"
[1.7.x] Fixed #22809 -- Added model Field API reference.
Thanks to @timgraham for the review.
Backport of e1fa7dffdc from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/22809#comment:10>