Skip to content

Update parameters.rst #8264

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 3 commits into from
Closed

Update parameters.rst #8264

wants to merge 3 commits into from

Conversation

afurculita
Copy link
Contributor

Setting php constants as parameters is different for each configuration format.

key and define the type as ``constant``.
For the XML format, you need to map the name of your constant to a parameter
key and define the type as ``constant``. For the YAML format, you need to prefix
the name of your constant with ``!php/const:``.
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure about this change. I mean the following code blocks already show how to do this. Why should we describe it here again?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The documentation now says "To take advantage of this feature, map the name of your constant to a parameter key and define the type as constant". But this is true only for XML format. We need to remove this or to specify that is only for XML format and describe the other ones too. I preferred the second one. The PHP format hasn't been described as it is trivial IMO.

Copy link
Member

Choose a reason for hiding this comment

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

You're right. Though I suggest to just remove the second sentence and terminate the previous one with a colon instead.

To take advantage of this feature, map the name of your constant to a parameter
key and define the type as ``constant``.
For the XML format, you need to map the name of your constant to a parameter
key and define the type as ``constant``:
Copy link
Member

Choose a reason for hiding this comment

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

Sorry, if that wasn't clear enough. I would replace the whole paragraph (line 245 to 247) with this:

Setting PHP constants as parameters is also supported:

@xabbuh xabbuh added this to the 3.3 milestone Aug 14, 2017
@xabbuh
Copy link
Member

xabbuh commented Aug 29, 2017

Thank you @afurculita.

xabbuh added a commit that referenced this pull request Aug 29, 2017
This PR was squashed before being merged into the 3.3 branch (closes #8264).

Discussion
----------

Update parameters.rst

Setting php constants as parameters is different for each configuration format.

Commits
-------

4dc9cc7 Update parameters.rst
@xabbuh xabbuh closed this Aug 29, 2017
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.

3 participants