Add documentation for only_code

Co-authored-by: Jan-Hendrik Ewers <[email protected]>
platisd · Mar 30, 2022 · a4f5036 · a4f5036
1 parent 8f55f83
commit a4f5036
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -151,6 +151,9 @@ jobs:
           warn_above: 15
           # Remove `src/` from the file paths when reporting similarities
           project_root_dir: "src"
+          # Remove docstrings from code before analysis
+          # For python source code only. This is checked on a per-file basis
+          only_code: true
 ```
 
 ## Limitations