Skip to content

Commit 24d1918

Browse files
committed
docs: 📝 Update
1 parent 2591bdc commit 24d1918

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

docs/configuration.md

+13-14
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,29 @@
22

33
## Excluding functions
44

5-
Functions can be excluded from analysis by putting a `# nocl` comment on the
6-
line above the start of the function, or at any line of the function header.
5+
Functions can be excluded from analysis by putting a `nocl` comment
6+
(case-insensitive) on the line of the name of function.
77

8-
For example, to ignore a function with a `# nocl` comment above the start of
9-
the function:
8+
For example, to ignore a Python function:
109

1110
```python
12-
# nocl
13-
def some_function():
11+
def some_function(): # nocl
1412
...
1513
```
1614

17-
Or you can ignore a function by putting a `# nocl` comment on any line of the
18-
header:
15+
or to ignore this Python function:
1916

2017
```python
21-
def some_function(): # nocl
18+
def some_functions( # nocl
19+
some_numbers: list[int]
20+
) -> int:
2221
...
2322
```
2423

25-
```python
26-
def some_functions(
27-
some_numbers: list[int]
28-
) -> int: # nocl
24+
or to ignore this C function:
25+
26+
```c
27+
void some_function(int a, const char *b) { // nocl
2928
...
3029
```
3130
@@ -71,4 +70,4 @@ The default exclusion list is:
7170
"test",
7271
"tests",
7372
]
74-
```
73+
```

0 commit comments

Comments
 (0)