Skip to content

Commit

Permalink
Cosmetics.
Browse files Browse the repository at this point in the history
  • Loading branch information
jendrikseipp committed Oct 9, 2024
1 parent 798809a commit f0ab7ba
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# next (unreleased)

* Add typehints for `get_unused_code` and the fields of the `Item` class (John Doknjas, #361).
* Add type hints for `get_unused_code` and the fields of the `Item` class (John Doknjas, #361).

# 2.13 (2024-10-02)

Expand Down
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,16 +191,6 @@ Vulture will automatically look for a `pyproject.toml` in the current working di

To use a `pyproject.toml` in another directory, you can use the `--config path/to/pyproject.toml` flag.

It's also possible to use vulture programatically. For example:

``` python
import vulture

v = vulture.Vulture()
v.scavenge(['.'])
unused_code = v.get_unused_code() # returns a list of `Item` objects
```

## Integrations

You can use a [pre-commit](https://pre-commit.com/#install) hook to run
Expand All @@ -219,7 +209,16 @@ Then run `pre-commit install`. Finally, create a `pyproject.toml` file
in your repository and specify all files that Vulture should check under
`[tool.vulture] --> paths` (see above).

There's also a [GitHub Action for Vulture](https://github.com/gtkacz/vulture-action).
There's also a [GitHub Action for Vulture](https://github.com/gtkacz/vulture-action)
and you can use Vulture programatically. For example:

``` python
import vulture
v = vulture.Vulture()
v.scavenge(['.'])
unused_code = v.get_unused_code() # returns a list of `Item` objects
```

## How does it work?

Expand Down

0 comments on commit f0ab7ba

Please sign in to comment.