Fixing syntax error in PHP, XML and Yaml examples #15250
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Nyholm
commented
Apr 16, 2021
wouterj
reviewed
Apr 16, 2021
There was a problem hiding this comment.
Whoa, this is a huge work! Thanks for starting this Tobias.
I've left a couple comments on places where I'm not sure if we improved the code example. I think conveying the correct meaning is more important for doc examples than being 100% syntax correct (in any case, I'm +1000 for the cases where you "completed" the example by e.g. adding the class definition).
Nyholm
commented
Apr 16, 2021
javiereguiluz
approved these changes
Apr 17, 2021
Merged
xabbuh
requested changes
Apr 19, 2021
57d1b05 to
baf9154
Compare
|
This has been merged in 4.4, 5.2 and 5.x, so we're ready to fix more errors in upper branches. Thanks Tobias! |
|
Wohoo. Thank you for merging |
javiereguiluz
added a commit
that referenced
this pull request
Apr 21, 2021
This PR was squashed before being merged into the 4.4 branch. Discussion ---------- Verify code blocks This PR is a first step to make sure we are using valid code blocks. I created a [small parser](https://github.com/symfony-docs-tools/code-block-checker) that will replace [the PR to the docs builder](https://github.com/weaverryan/docs-builder/pull/97). This CI job will look at the modified files, and give the the the [code-block-checker](https://github.com/symfony-docs-tools/code-block-checker). That project will find the code blocks and make sure they are using valid syntax. It also supports a baseline so we can write invalid syntax if we want to. (it may sometimes make the examples more readable See #15250) ~~The next step is to make sure one can actually run code examples. Im planning to get all examples that starts with a comment and figure out if that is a filepath to the config directory. I will then capture any symfony errors when using that config.~~ This is super helpful when updating the PHP config to use the config builders. EDIT: I included "the next step" in this PR. We do run all config examples. Note that thanks to the baseline feature, will only report **new** errors on modified code blocks. Commits ------- c92641d Verify code blocks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I used my new and shiny feature to the docs-parser =)
https://github.com/weaverryan/docs-builder/pull/97