Opened 3 years ago

Last modified 4 months ago

#21993 new Cleanup/optimization

Messages documentation is topic style, there is no ref

Reported by: mjtamlyn Owned by: nobody
Component: Documentation Version: master
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 (3)

comment:1 Changed 3 years ago 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"?

comment:2 Changed 3 years ago 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)

comment:3 Changed 4 months ago 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?

Note: See TracTickets for help on using tickets.
Back to Top