8000 Unify placeholders in documentation and code by aivus · Pull Request #7390 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Unify placeholders in documentation and code #7390

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 15, 2017
Merged

Unify placeholders in documentation and code #7390

merged 1 commit into from
Apr 15, 2017

Conversation

aivus
Copy link
Contributor
@aivus aivus commented Jan 19, 2017

Update validation documentation to unify approach with placeholders.

Constraints/Validators in code have {{ value }} placeholders, but documentation %value%.
It could confuse.

I propose to update documentation to use {{ value }} placeholders

@xabbuh
Copy link
Member
xabbuh commented Jan 19, 2017

👍 makes sense given that this pattern is also used in the translations shipped with the Validator component

Status: Reviewed

@xabbuh
Copy link
Member
xabbuh commented Feb 3, 2017

@javiereguiluz What is your opinion here? This is a bit tricky as the Validator component uses different placeholders than what is the best practice for all other translations we document.

javiereguiluz
javiereguiluz approved these changes Apr 15, 2017
View reviewed changes
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.

👍 I think it makes sense in the short term to merge this in order to avoid confusion between code and docs for validator.

But in the long-term we should rethink all placeholders in the entire codebase of all components.

@xabbuh
Copy link
Member
xabbuh commented Apr 15, 2017

Thank you @aivus.

@xabbuh xabbuh merged commit 274ffc5 into symfony:2.7 Apr 15, 2017
xabbuh added a commit that referenced this pull request Apr 15, 2017
@xabbuh
minor #7390 Unify placeholders in documentation and code (aivus)
15d0cc2 
This PR was merged into the 2.7 branch.

Discussion
----------

Unify placeholders in documentation and code

Update validation documentation to unify approach with placeholders.

Constraints/Validators in code have `{{ value }}` placeholders, but documentation `%value%`.
It could confuse.

I propose to update documentation to use `{{ value }}` placeholders

Commits
-------

274ffc5 Unify placeholders in documentation and code
@aivus aivus deleted the patch-1 branch April 15, 2017 14:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@javiereguiluz javiereguiluz javiereguiluz approved these changes

Assignees
No one assigned
Labels
Status: Reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@aivus @xabbuh @javiereguiluz @carsonbot
0