Skip to content

Commit 3d2065e

Browse files
committed
update readme
1 parent 41caedb commit 3d2065e

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ The functionality is kept simple and all default shall be reasonable, but still
5050
* specify warning count per:
5151
- called function (for func deprecation)
5252
- used arguments (for argument deprecation)
53+
* define conditional skip (e.g. depending on some package version)
5354

5455
In particular the target values (cases):
5556

@@ -178,6 +179,9 @@ sample output:
178179
8
179180
```
180181

182+
<details>
183+
<summary>Multiple deprecation levels</summary>
184+
181185
Eventually you can set multiple deprecation levels via chaining deprecation arguments as each could be deprecated in another version:
182186

183187
```python
@@ -204,6 +208,8 @@ sample output:
204208
8
205209
```
206210

211+
</details>
212+
207213
### Conditional skip
208214

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

246+
This can be beneficial with multiple deprecation levels shown above...
247+
240248
### Class deprecation
241249

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

0 commit comments

Comments
 (0)