[Messenger] Replace tables by definition lists #20326
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
javiereguiluz
force-pushed
the
messenger_tables
branch
from
e479f79 to
9f417f0
Compare
MrYamous
reviewed
Oct 15, 2024
Comment on lines
+1735
to
+1736
| ``sentinel_master`` | ||
| String, if null or empty Sentinel support is disabled |
There was a problem hiding this comment.
Looks like the redis_sentiel alias has been removed, was this intentional ?
|
That makes me think, what about dropping documentation for third-party transport configuration as done for Mailer and Notifier in favor of readme for each bridge ? |
|
Closing in favor of #20330 because this one contains a rebasing issue that I can't fix. |
|
@MrYamous I wouldn't do that because it's very cumbersome to readers. Even if it's a bit long, having all options in the same article is super convenient. In Mailers, Notifiers, etc. we can't do that because there are tens and tens of integrations and they change frequently, and nobody in the Core Team uses most of them, etc. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a general rule, we should never use tables for list of options with long descriptions. The tables look ugly and the option names are unreadable:
In this PR, I propose to replace all tables with definition lists, which we use in all the other docs.