Skip to content

Commit

Permalink
docs: 📝 Update
Browse files Browse the repository at this point in the history
  • Loading branch information
robvanderleek committed Jan 7, 2025
1 parent 2591bdc commit 24d1918
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
...
```
Expand Down Expand Up @@ -71,4 +70,4 @@ The default exclusion list is:
"test",
"tests",
]
```
```

0 comments on commit 24d1918

Please sign in to comment.