Re: [Django] #5405: Support restructured text in model docstrings
Django
-------------------------------+------------------------------------
Reporter: mattmcc | Owner: nobody
Type: New feature | Status: new
Component: contrib.admin | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-------------------------------+------------------------------------
Changes (by lrekucki):
* needs_better_patch: 0 => 1
* easy: 0 => 1
Comment:
Duplicated by #19062.
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:12>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: mattmcc | Owner: nobody
Type: New feature | Status: new
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
Changes (by Elvard):
* cc: tomas.ehrlich@… (added)
* component: contrib.admin => contrib.admindocs
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:13>
Django
-----------------------------------+------------------------------------
Reporter: mattmcc | Owner: nobody
Type: New feature | Status: new
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-----------------------------------+------------------------------------
Comment (by Elvard):
Also duplicated by #17599 which has very similar patch. I'll post updated
version soon.
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:14>
Django
-----------------------------------+------------------------------------
Reporter: mattmcc | Owner: nobody
Type: New feature | Status: new
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-----------------------------------+------------------------------------
Comment (by Elvard):
Patch updated, but I'm not sure how to write tests. There're no similar
tests in `django.contrib.admindocs.tests`. I renamed `body` in original
patch to `description` to keep the backward compatibility (in case someone
has it's own version of `model_detail.html`).
Also, the ticket #17599 is talking about model_detail only, but there's
another misleading information in docs, about using `:model:` reference in
view function. It didn't work for me and I've found there's a striptags
filter, which strips all generated links. It's included in the second
patch.
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:15>
Django
-----------------------------------+------------------------------------
Reporter: mattmcc | Owner: nobody
Type: New feature | Status: new
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 1 | UI/UX: 0
-----------------------------------+------------------------------------
Comment (by Elvard):
https://github.com/django/django/pull/484
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:16>
Django
-----------------------------------+------------------------------------
Reporter: mattmcc | Owner: nobody
Type: New feature | Status: new
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------------+------------------------------------
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:17>
Django
-----------------------------------+------------------------------------
Reporter: mattmcc | Owner: nobody
Type: New feature | Status: new
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------------+------------------------------------
Comment (by gokmen):
https://github.com/django/django/pull/760
i need to review to improve tests.
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:18>
Django
Reporter: mattmcc | Owner: gokmen
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
Has patch: 1 | Patch needs improvement: 0
Needs tests: 1 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Changes (by gokmen):
* owner: nobody => gokmen
* cc: gokmen@… (added)
* status: new => assigned
* keywords: nfa-someday => nfa-someday sprint2013
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:19>
Django
-------------------------------------+-------------------------------------
Reporter: mattmcc | Owner: gokmen
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
Has patch: 1 | Patch needs improvement: 1
Needs tests: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Changes (by timo):
* needs_better_patch: 0 => 1
* needs_tests: 1 => 0
* needs_docs: 0 => 1
Comment:
I left comments on the [https://github.com/django/django/pull/760 pull
request] but it still needs some improvement including a rebase to merge
cleanly. It would also be good to mention the change in the release notes.
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:20>
Django
-------------------------------------+-------------------------------------
Reporter: mattmcc | Owner: gokmen
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
sprint2013 | Needs documentation: 1
Has patch: 1 | Patch needs improvement: 1
Needs tests: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by timo):
* easy: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:21>
Django
-------------------------------------+-------------------------------------
Reporter: mattmcc | Owner: gokmen
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
sprint2013 | Needs documentation: 1
Has patch: 1 | Patch needs improvement: 1
Needs tests: 0 | UI/UX: 0
Easy pickings: 0 |
-------------------------------------+-------------------------------------
Comment (by aaugustin):
#22428 was a duplicate with a patch.
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:22>
Django
-------------------------------------+-------------------------------------
Reporter: mattmcc | Owner: gokmen
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
sprint2013 | Needs documentation: 1
Has patch: 1 | Patch needs improvement: 1
Needs tests: 0 | UI/UX: 0
Easy pickings: 0 |
-------------------------------------+-------------------------------------
Comment (by zanderle):
gokmen, are you still working on this? Otherwise, I'll give it a shot
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:23>
Django
-------------------------------------+-------------------------------------
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
sprint2013 | Needs documentation: 1
Has patch: 1 | Patch needs improvement: 1
Needs tests: 0 | UI/UX: 0
Easy pickings: 0 |
-------------------------------------+-------------------------------------
* cc: zanderle (added)
* owner: gokmen => zanderle
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:24>
Django
-------------------------------------+-------------------------------------
Reporter: mattmcc | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Keywords: nfa-someday | Triage Stage: Accepted
sprint2013 | Needs documentation: 1
Has patch: 1 | Patch needs improvement: 1
Needs tests: 0 | UI/UX: 0
Easy pickings: 0 |
-------------------------------------+-------------------------------------
Comment (by zanderle):
https://github.com/django/django/pull/3457
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:25>
Django
-------------------------------------+-------------------------------------
Reporter: mattmcc | Owner: zanderle
Type: New feature | Status: assigned
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution:
Has patch: 1 | checkin
Needs tests: 0 | Needs documentation: 0
Easy pickings: 0 | Patch needs improvement: 0
| UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by MarkusH):
* cc: info+coding@… (added)
* keywords: nfa-someday sprint2013 =>
* needs_better_patch: 1 => 0
* needs_docs: 1 => 0
* stage: Accepted => Ready for checkin
Comment:
The patch looks good to me.
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:26>
Django
-------------------------------------+-------------------------------------
Reporter: mattmcc | Owner: zanderle
Component: contrib.admindocs | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
Has patch: 1 | checkin
Needs tests: 0 | Needs documentation: 0
Easy pickings: 0 | Patch needs improvement: 0
| UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"7b420367524ad9f29b8bf0284f4b40bd6cfc8b93"]:
{{{
#!CommitTicketReference repository=""
revision="7b420367524ad9f29b8bf0284f4b40bd6cfc8b93"
Fixed #5405 -- Added admindocs support for reStructured text in model
docstrings
Thanks elvard and gkmngrgn for work on the patch and Markus H. for review.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/5405#comment:27>