-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Update framework.rst #9965
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
Update framework.rst #9965
Conversation
default_path | ||
..... | ||
|
||
**type**: ``string`` **default**: ``[]`` |
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.
the default value looks wrong to me (this should be %kernel.project_dir%/translations
)
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.
Thanks, you are right
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.
@apodgorbunschih thanks for contributing the docs for this missing config option. We appreciate it a lot and we thank you your first Symfony Docs contribution.
I left some comments because the format we use to write the docs is a bit strict, but you did it great. Cheers!
.. _reference-translator-default_path: | ||
|
||
default_path | ||
..... |
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.
The format we use for the docs is more strict that Markdown, so for example, the line below the heading must have the exact same length. Please, add the missing dots like this:
default_path
............
|
||
**type**: ``string`` **default**: ``%kernel.project_dir%/translations`` | ||
|
||
This option allows to define a path where the component will write |
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.
I'm not sure about this description. Should we change it for this other description?
This option allows to define the path where the application translations files
are stored.
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.
Actually it's two default things: it is where the command generates translation files and where domains take precedence on other registrations.
default_path | ||
..... | ||
|
||
**type**: ``string`` **default**: ``%kernel.project_dir%/translations`` |
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.
When documenting a new feature, we put a warning about the Symfony version where it was introduced. Could you please put this before this line? Thanks!
default_path
............
.. versionadded:: 3.4
The ``default_path`` option was introduced in Symfony 3.4.
**type**: ``string`` **default**: ...
@apodgorbunschih will you have some time to make the suggested changes and fix the merge conflicts? Please note: because of the way Symfony does things, those conflicts can't be solved with the |
@javiereguiluz thanks for feedback, sorry for long delay, i will try to fix the conflicts today or tomorrow. |
@apodgorbunschih thanks a lot for your contribution and for making it ready for merge. Congrats on your first Symfony Docs contribution! |
Adding the default_path option to translator configuration