From 24d19183b0b4abcdf3e6b187310fff7a460be96f Mon Sep 17 00:00:00 2001 From: Rob van der Leek <5324924+robvanderleek@users.noreply.github.com> Date: Tue, 7 Jan 2025 22:12:58 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20Update?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/configuration.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index cae964e..fb6ac3c 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -2,30 +2,29 @@ ## Excluding functions -Functions can be excluded from analysis by putting a `# nocl` comment on the -line above the start of the function, or at any line of the function header. +Functions can be excluded from analysis by putting a `nocl` comment +(case-insensitive) on the line of the name of function. -For example, to ignore a function with a `# nocl` comment above the start of -the function: +For example, to ignore a Python function: ```python -# nocl -def some_function(): +def some_function(): # nocl ... ``` -Or you can ignore a function by putting a `# nocl` comment on any line of the -header: +or to ignore this Python function: ```python -def some_function(): # nocl +def some_functions( # nocl + some_numbers: list[int] +) -> int: ... ``` -```python -def some_functions( - some_numbers: list[int] -) -> int: # nocl +or to ignore this C function: + +```c +void some_function(int a, const char *b) { // nocl ... ``` @@ -71,4 +70,4 @@ The default exclusion list is: "test", "tests", ] -``` \ No newline at end of file +```