diff --git a/slither/tools/documentation/README.md b/slither/tools/documentation/README.md index 2ed90692c..5e70b3a49 100644 --- a/slither/tools/documentation/README.md +++ b/slither/tools/documentation/README.md @@ -1,6 +1,6 @@ -# Demo +# slither-documentation -This directory contains an example of Slither utility. +`slither-documentation` uses [codex](https://beta.openai.com) to generate natspec documenation. -See the [utility documentation](https://github.com/crytic/slither/wiki/Adding-a-new-utility) +This tool is experimental. See https://github.com/montyly/solmate/pull/1 for an example of usage. diff --git a/slither/tools/documentation/__main__.py b/slither/tools/documentation/__main__.py index 1f2280de7..8e545fb09 100644 --- a/slither/tools/documentation/__main__.py +++ b/slither/tools/documentation/__main__.py @@ -211,7 +211,7 @@ def _handle_compilation_unit( for scope in compilation_unit.scopes.values(): - # TODO remove hardcoded filtering + # Dont send tests file if ( ".t.sol" in scope.filename.absolute or "mock" in scope.filename.absolute.lower()