[Notifier][Mercure] Document options in README file #60259
+28
−0
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
9c70369 to
2235584
Compare
|
|
||
| $chatMessage = new ChatMessage('Contribute To Symfony'); | ||
|
|
||
| $options = new MercureOptions( |
There was a problem hiding this comment.
Given that we decided to not use named arguments in Symfony Docs, could we please add a short comment to explain what does each option mean in this code example? Thanks!
There was a problem hiding this comment.
that's also because MercureOptions is diverging from the other option classes
the norm is to have a constructor with only array $options and to then have fluent setters, see existing classes for inspiration
it'd be nice to check all option classes and add some consistency - looks like it might be needed 🙏
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.
Document mercure notifier options in component readme (as others)
symfony/symfony-docs#20857