Skip to content
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

[Controller Description] Fix typos and class link #6913

Closed
wants to merge 3 commits into from
Closed

[Controller Description] Fix typos and class link #6913

wants to merge 3 commits into from

Conversation

rendler-denis
Copy link
Contributor

  • fix typo in first code example from $name to $max
  • add link to the Request class instead of just make the name bold

- fix typo in first code example from $name to $max
- add link to the Request class instead of just make the name bold
@wouterj
Copy link
Member

wouterj commented Aug 25, 2016

Thanks for the typo fix, that's correct!

However, in reStructured Text (the markup language used), you can't nest inline markup. So your code doesn't work either (see also the platform.sh build of this PR). Can you please update this PR (by adding a new commit to the patch-4 branch) to remove all markup around Request (so just making it bold, no literals or API references)? Thanks! (if you don't have the time, just comment and we'll do it during the merge)

status: needs work

- remove the nested mark-up referencing the HttpFoundation\Request class due to inline markup nesting not possible in the reStructured Text format
@rendler-denis
Copy link
Contributor Author

Hello, @wouterj! Thanks for the heads-up. I wasn't aware of this limitation and I should have checked the deployment results. It is a good lesson for the future PRs.
I updated the mark-up as you suggested.
Thanks, Denis!

@wouterj
Copy link
Member

wouterj commented Aug 26, 2016

👍
status: reviewed

Thanks for your quick reactions! (if you have some time, please remove the single backticks around Request as well)

- remove backticks from Request class name
@rendler-denis
Copy link
Contributor Author

@wouterj, changes done! :)

@wouterj
Copy link
Member

wouterj commented Aug 28, 2016

Perfect! Thanks again Denis! Fyi, I've merged the changes in 2.7 and will merge them into the newer versions from there

wouterj added a commit that referenced this pull request Aug 28, 2016
…r-denis)

This PR was submitted for the 3.0 branch but it was merged into the 2.7 branch instead (closes #6913).

Discussion
----------

[Controller Description] Fix typos and class link

- fix typo in first code example from $name to $max
- add link to the Request class instead of just make the name bold

Commits
-------

a0bbfae [Controller Description] Remove backticks
74addb0 [Controller] Fix nested inline markup
e017723 [Controller Description] Fix typos and class link
@wouterj wouterj closed this Aug 28, 2016
@rendler-denis rendler-denis deleted the patch-4 branch August 29, 2016 05:45
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