Opened 11 years ago
Closed 4 years ago
#21993 closed Cleanup/optimization (needsinfo)
Messages documentation is topic style, there is no ref
Reported by: | Marc Tamlyn | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
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".
Change History (4)
comment:1 by , 11 years ago
comment:2 by , 11 years ago
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)
comment:3 by , 9 years ago
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?
comment:4 by , 4 years ago
Resolution: | → needsinfo |
---|---|
Status: | new → closed |
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"?