Skip to content

Commit f2e3b00

Browse files
committed
Add more usage examples
1 parent 3bf6b16 commit f2e3b00

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![Deadcode Logo](https://raw.githubusercontent.com/albertas/deadcode/main/docs/_static/deadcode-logo-readme.png)](https://deadcode.readthedocs.io/en/stable/)
22

3-
<h2 align="center">Detect and Fix Unused Python Code</h2>
3+
<h2 align="center">Find and Fix Unused Python Code</h2>
44

55
<p align="center">
66
<a href="https://github.com/albertas/deadcode/blob/main/LICENSE"><img alt="License: AGPLv3" src="https://raw.githubusercontent.com/albertas/deadcode/main/docs/_static/AGPLv3-license.svg"></a>
@@ -15,11 +15,22 @@ pip install deadcode
1515
```
1616

1717
## Usage
18+
To see unused code findings:
1819
```shell
1920
deadcode .
2021
```
2122

22-
Or with command line options:
23+
To see suggested fixes:
24+
```shell
25+
deadcode . --fix --dry
26+
```
27+
28+
To fix:
29+
```shell
30+
deadcode . --fix
31+
```
32+
33+
Tune out some of the false positives, e.g.:
2334
```
2435
deadcode . --exclude=venv,tests --ignore-names=BaseTestCase,*Mixin --ignore-names-in-files=migrations
2536
```

0 commit comments

Comments
 (0)