[Django] #21993: Messages documentation is topic style, there is no ref
Django
------------------------------------------------+------------------------
Reporter: mjtamlyn | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Accepted | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
The messages documentation lives in `ref` not in topics, but it's written
as a `topic` style document. There is no "list of the messages API".
--
Ticket URL: <https://code.djangoproject.com/ticket/21993>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: mjtamlyn | Owner: nobody
Type: 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
Comment (by timo):
All of the contrib modules are documented in ref, even if the document is
written topic style. I don't see much benefit in splitting things up
except for the more complicated modules that are already split. Could you
clarify what you mean by "list of of the messages API"?
--
Ticket URL: <https://code.djangoproject.com/ticket/21993#comment:1>
Django
Reporter: mjtamlyn | Owner: nobody
Type: 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
Comment (by bmispelon):
Regardless of whether it should be split over two pages or not, I think
the messages framework documentation could benefit from having a
technically-oriented exhaustive list of its API (`contrib.messages.api`).
As things are now, the available functions are mentionned in various
places on the page (sometimes only briefly)
--
Ticket URL: <https://code.djangoproject.com/ticket/21993#comment:2>
Django
Reporter: mjtamlyn | Owner: nobody
Type: 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
Comment (by tobias):
The messages documentation was modeled in topic style after the sessions
documentation (which, although it lives in a different place in the file
hierarchy, appears to be the outlier in that regard).
@bmispelon what methods do you feel are not clearly explained in the
existing documentation?
--
Ticket URL: <https://code.djangoproject.com/ticket/21993#comment:3>
Django
Reporter: Marc Tamlyn | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: dev
Severity: Normal | Resolution: needsinfo
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 Mariusz Felisiak):
* status: new => closed
* resolution: => needsinfo
--
Ticket URL: <https://code.djangoproject.com/ticket/21993#comment:4>