[Messenger] Replace the tables by definition lists #20330
Merged
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
mdoutreluingne
approved these changes
Oct 15, 2024
messenger.rst
Outdated
Comment on lines
1707
to
1708
| ``auto_setup`` (default: ``true``) | ||
| Create the Redis group automatically? |
There was a problem hiding this comment.
I think that here it should be a description and not a question, what do you think?
There was a problem hiding this comment.
You are right. I renamed it as Whether to create the Redis group automatically. Thanks.
javiereguiluz
force-pushed
the
fix_messenger_tables
branch
from
dc0f5a7 to
4196676
Compare
javiereguiluz
force-pushed
the
fix_messenger_tables
branch
from
4196676 to
d0ed00f
Compare
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.