-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
use same order for all configuration-blocks #11179
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
use same order for all configuration-blocks #11179
Conversation
Hmm, not sure if I agree with this "rule". For some reason (not sure why), Symfony decided Xliff should be the main language for translation instead of yaml. So that's why it's put in the first place. |
If I browse the documentation and and select Anyway it wouldn't be a problem to use My goal is to make the docs consistent as possible to give fast automated feedback to the contributors, especially new ones. I totally agree, that we cannot have "rules" for everything 👍 |
Even if being consistent is important (and we appreciate all your work around this) I think I agree with Wouter on this one. The order of configuration-block formats is from "most common"/"recommended" ... to "less common". So, for routes: annotations, yaml, xml, raw php ... but for translation it should be xml, yaml, raw php. This is for the reason explained by Wouter about XLIFF. Also, precisely because the tab is now selected automatically (and persisted when you change it) the tab order is almost irrelevant, because you always see your preferred format selected. |
69c1ae2
to
c99239c
Compare
ensure the following order of code-blocks in a .. configuration-block:: directive: - php-annotations - yaml - xml - php
c99239c
to
7cfa0d7
Compare
Thank you for your feedback Javier! I changed the rule to ensure the following order if an
If an
After that change, the current state of the PR is the result and it looks good to me 👍 |
@@ -48,6 +40,14 @@ Basic Usage | |||
protected $identifier; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
off topic but shouldn't we change properties to private
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably yes ... but, as you said, off topic :)
Thanks Oskar. |
This PR was merged into the 3.4 branch. Discussion ---------- use same order for all configuration-blocks ensure the following order of code-blocks in a `.. configuration-block::` directive: 1. `php-annotations` 2. `yaml` 3. `xml` 4. `php` Commits ------- 7cfa0d7 use same order for all configuration-blocks
You are very welcome 😊 |
ensure the following order of code-blocks in a
.. configuration-block::
directive:php-annotations
yaml
xml
php