Make snippets CS compliant #2620
Merged
Conversation
This file contains 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
- Fix CS on all v2 docs code snippets - Fix PHP syntax errors in snippets - Self promote var-dumper-configurator package :)
|
The command to fix snippets: vendor/bin/ecs check-markdown docs/v2/**/*.md --fixMaybe we should include it in the composer scripts. |
|
Wait... that is... what in the …
I didn’t know you could do that! Yes, yes, yes, yes! This is amazing. 🍾😍🥳 Let’s also include that command in the Composer scripts. I assume you saw my note about the documentation coding standards in the changes to CONTRIBUTING.md in #2619. I can update that pull request based on this. |
gchtr
previously approved these changes
Jul 28, 2022
|
Glad you like it with such enthusiasm! 😄 Can you approve it again? |
gchtr
approved these changes
Jul 28, 2022
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.
The choice of ECS to run coding standards checks was also motivated by its ability to fix code snippets in markdown files to avoid too much manual maintenance of docs snippets. Note that for the CS fixing to work properly, the snippets have to be valid PHP.
This PR has been a chance to fix many syntax errors in those snippets (missing parenthesis, bracket, etc.).