8000 For now, mark this tool as internal (#21) · Nyholm/code-block-checker@a31d3cc · GitHub
[go: up one dir, main page]

Skip to content

Commit a31d3cc

Browse files
authored
For now, mark this tool as internal (symfony-tools#21)
1 parent 39a7a8d commit a31d3cc

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
1-
# Code block checker
1+
# Symfony Code Block Checker
22

3-
Make sure that code blocks have valid syntax and can actually run.
3+
Makes sure that code blocks have valid syntax and can actually run.
44

55
```terminal
6-
$ ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev
6+
$ php ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev
77
88
::error file=cache,line=377::[Invalid syntax] PHP Parse error: syntax error, unexpected token "}"
99
1010
[ERROR] Build completed with 1 errors
1111
1212
13-
$ ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev --generate-baseline=baseline.json
14-
$ ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev --baseline=baseline.json
13+
$ php ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev --generate-baseline=baseline.json
14+
$ php ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev --baseline=baseline.json
1515
1616
[OK] Build completed successfully!
1717
1818
```
1919

20+
This project is considered **an internal tool** and therefore, you
21+
**shouldn't use this project in your application**. Unlike the rest of the
22+
Symfony projects, this repository doesn't provide any support and it doesn't
23+
guarantee backward compatibility either. Any or the entire project can change,
24+
or even disappear, at any moment without prior notice.

0 commit comments

Comments
 (0)
0