docs: update usage/channels
#3351
Conversation
github-actions
bot
added
area/docs
|
I recommend reviewing with whitespace changes off because the diff is stupid |
|
ready |
|
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3351 |
| @@ -11,115 +11,143 @@ Channels provide: | |||
|
|
|||
| 1. Independent :term:`broker` backends, optionally handling inter-process communication | |||
| and data persistence on demand | |||
| 2. "Channel" based subscription management | |||
| 2. "Channel" based :term:`subscription` management | |||
There was a problem hiding this comment.
Seems the glossary section needs to be expanded for the term links to work. Can that be expanded by default?
There was a problem hiding this comment.
It can but if it I think i'd prefer it at the bottom of the page since its chunky
|
|
||
| Broker --> Backend_1(Backend) | ||
| Broker --> Backend_2(Backend) | ||
| .. dropdown:: Click to expand flowcharts |
|
|
||
| Broker --> Backend_1(Backend) | ||
| Broker --> Backend_2(Backend) | ||
| .. dropdown:: Click to expand flowcharts |
There was a problem hiding this comment.
Is this actually necessary? We already have the side-nav where you can easily skip the section if you're not interested in that.
|
|
||
| .. note:: | ||
| While calling :meth:`publish <ChannelsPlugin.publish>` does not guarantee the | ||
| .. note:: While calling :meth:`~ChannelsPlugin.publish` does not guarantee the |
There was a problem hiding this comment.
| .. note:: While calling :meth:`~ChannelsPlugin.publish` does not guarantee the | |
| .. note:: | |
| While calling :meth:`~ChannelsPlugin.publish` does not guarantee the |
The first line shouldn't be the title :)
| .. seealso:: | ||
|
|
||
| * `Managing backpressure`_ | ||
| Read more: `Managing backpressure`_ |
There was a problem hiding this comment.
It was nested inside of another one 😬
|
|
||
| .. important:: | ||
| The :term:`events <event>` in the :term:`event streams <event stream>` are always | ||
| .. important:: The :term:`events <event>` in the :term:`event streams <event stream>` are always |
There was a problem hiding this comment.
| .. important:: The :term:`events <event>` in the :term:`event streams <event stream>` are always | |
| .. important:: | |
| The :term:`events <event>` in the :term:`event streams <event stream>` are always |
| The publication of the history happens sequentially, one channel and one | ||
| event at a time. This is done to ensure the correct ordering of events and to avoid | ||
| filling up a subscriber's backlog, which would result in dropped history entries. Should the | ||
| .. note:: The publication of the :term:`history` happens sequentially, one :term:`channel` and one |
There was a problem hiding this comment.
| .. note:: The publication of the :term:`history` happens sequentially, one :term:`channel` and one | |
| .. note:: | |
| The publication of the :term:`history` happens sequentially, one :term:`channel` and one |
There was a problem hiding this comment.
This seems to be a spacing issue it shouldnt do this, everywhere else i've done this it is proper. Will fix
Description
usage/channelsas part of docs: update links, formatting, grammar, and remove contractions #3212 workCloses