Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Borda committed Apr 21, 2021
1 parent 41caedb commit 3d2065e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ The functionality is kept simple and all default shall be reasonable, but still
* specify warning count per:
- called function (for func deprecation)
- used arguments (for argument deprecation)
* define conditional skip (e.g. depending on some package version)

In particular the target values (cases):

Expand Down Expand Up @@ -178,6 +179,9 @@ sample output:
8
```

<details>
<summary>Multiple deprecation levels</summary>

Eventually you can set multiple deprecation levels via chaining deprecation arguments as each could be deprecated in another version:

```python
Expand All @@ -204,6 +208,8 @@ sample output:
8
```

</details>

### Conditional skip

Conditional skip of which can be used for mapping between different target functions depending on additional input such as package version
Expand Down Expand Up @@ -237,6 +243,8 @@ sample output:
4
```

This can be beneficial with multiple deprecation levels shown above...

### Class deprecation

This case can be quite complex as you may deprecate just some methods, here we show full class deprecation:
Expand Down

0 comments on commit 3d2065e

Please sign in to comment.