8000 Fix YAML and XML syntax errors in configuration blocks by michaelperrin · Pull Request #8014 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Fix YAML and XML syntax errors in configuration blocks #8014

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
Closed
wants to merge 1 commit into from
Closed

Fix YAML and XML syntax errors in configuration blocks #8014

wants to merge 1 commit into from

Conversation

michaelperrin
Copy link
Contributor
@michaelperrin michaelperrin commented Jun 9, 2017 •
edited
Loading

I changed the configuration blocks, especially for the XML version of configuration to conform to the XML file format.

Despite the fact that the syntax errors are "voluntary" to give hints to the reader for possible extra attributes, I fixed the doc for several reasons:

  • The code doesn't get highlighted on the Symfony docs pages because of these errors. Example: on the profiler data collector page, at the bottom, click on the XML tab and you will see it is not highlighted.
  • The documentation can't be compiled with newer versions of Sphinx (1.5.x) as it results in errors because of these syntax errors.
  • This is a regression since the Symfony 3.3 docs as there was no syntax error before.
  • The YAML error is indeed an error (backslashes need to be escaped in double-quote strings).

Screenshot of a non-highlighted code (due to the commented attribute, which is not allowed in XML):
how_to_create_a_custom_data_collector__current_

@michaelperrin
Copy link
Contributor Author

And it seems it fixed the platformsh deployment as well! ✅

@michaelperrin michaelperrin force-pushed the fix/configuration-blocks-syntax branch from 6b02dca to 958d827 Compare June 9, 2017 13:39
@robfrawley
Copy link
Contributor
robfrawley commented Jun 10, 2017 •
edited
Loading

This is a duplicate of #8009, short of the removed spaces, right?

@robfrawley robfrawley mentioned this pull request Jun 10, 2017
Merged
@michaelperrin
Copy link
Contributor Author

You're right @robfrawley , this is a duplicate of your PR. We both opened them almost at the same time! It's good to see we did the exact same thing separately.
There is one more changed I made in the argument_value_resolver.rst file, were I removed a ' char in the following string:

xmlns:xsi="'http://www.w3.org/2001/XMLSchema-Instance"

Maybe you could integrate is as well in your PR?

I am closing my PR, so the discussion can go on in yours (I would be interested if you manage to compile docs with Sphinx 1.6 for instance).

@robfrawley
Copy link
Contributor

The argument_value_resolver.rst change is already included, no?

@michaelperrin
Copy link
Contributor Author

@robfrawley Yes indeed, I didn't see it at first!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xabbuh xabbuh xabbuh 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
@michaelperrin @robfrawley @xabbuh @carsonbot
0