Skip to content

Commit 04c5511

Browse files
add comment regarding support of Markdown files
1 parent 4e472d5 commit 04c5511

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,12 @@ options:
108108

109109
Please note that db\* CODECOP applies by default a filter to support the following file extensions: `.sql`, `.prc`, `.fnc`, `.pks`, `.pkb`, `.trg`, `.vw`, `.tps`, `.tpb`, `.tbp`, `.plb`, `.pls`, `.rcv`, `.spc`, `.typ`, `.aqt`, `.aqp`, `.ctx`, `.dbl`, `.tab`, `.dim`, `.snp`, `.con`, `.collt`, `.seq`, `.syn`, `.grt`, `.sp`, `.spb`, `.sps`, `.pck`, `.md`, `.mdown`. To process other or additional file extensions, you must pass your own filter expression.
110110

111-
The value of all options will be included in the output files and on the console output.
111+
For Markdown files only the code within SQL code blocks is analyzed. If other file extensions than `.md` and `.mdown` are used then the content must start with a `#` to be identified as a Markdown file.
112112

113113
Guideline checks can be disabled when implementing a validator. When the `skip` option is not defined then all disabled guideines are skipped. To enable all checks pass `skip=none`.
114114

115+
The value of all options will be included in the output files and on the console output.
116+
115117
## Issues
116118
Please file your bug reports, enhancement requests, questions and other support requests within [Github's issue tracker](https://help.github.com/articles/about-issues/).
117119

0 commit comments

Comments
 (0)