Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

Closed
wants to merge 6 commits into from
Closed

Conversation

apodgorbunschih
Copy link
Contributor

Adding the default_path option to translator configuration

default_path
.....

**type**: ``string`` **default**: ``[]``
Copy link
Member

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)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, you are right

Copy link
Member

@javiereguiluz javiereguiluz left a 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
.....
Copy link
Member

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
Copy link
Member

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.

Copy link
Contributor

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``
Copy link
Member

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**: ...

@javiereguiluz
Copy link
Member

@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 Resolve conflicts button of GitHub. They must be solved in your local computer. If this is too much, you can create a new pull request or ask us to take over this. Thanks!

@apodgorbunschih
Copy link
Contributor Author

@javiereguiluz thanks for feedback, sorry for long delay, i will try to fix the conflicts today or tomorrow.

@javiereguiluz
Copy link
Member

@apodgorbunschih thanks a lot for your contribution and for making it ready for merge. Congrats on your first Symfony Docs contribution!

javiereguiluz added a commit that referenced this pull request Jul 16, 2018
This PR was squashed before being merged into the 3.4 branch (closes #9965).

Discussion
----------

Update framework.rst

Adding the default_path option to translator configuration

Commits
-------

4289160 Update framework.rst
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants