#30607: How to use Django specific markup in the docstrings.
-------------------------------------+-------------------------------------
Reporter: Anuj Sharma | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 2.2
Severity: Normal | Resolution: needsinfo
Keywords: writing- | Triage Stage:
documentation, Django-specific- | Unreviewed
markup |
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Carlton Gibson):
* status: new => closed
* resolution: => needsinfo
Comment:
> ...at least tell you what the name of the extension is, and where to
find it in order to add it?
The ''Writing documentation'' section linked is about writing docs for
Django itself, where it's already set up for you. (Is that the best
location for ''Writing documention for **your project**''?
So, **maybe** yes, an addition **somewhere** explaining that these
extensions exist **might** be worth adding.
I'm happy to Accept this ticket on the basis that such a patch was
provided, and then we could assess whether it looks good or not.
What I don't want to do is Accept it and then have it sit open for X years
whilst nobody works on it.
(I hope that makes sense.)
As such, I'll close it as `needsinfo` — that info being "is a patch going
to appear soon?". Please reopen, assign to yourself, and Accept if such a
patch is incoming.
--
Ticket URL: <https://code.djangoproject.com/ticket/30607#comment:5>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/066.2e95745f9f76977500fe035240ee95da%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
