Skip to content

Commit fdcbf36

Browse files
committed
docs: improve some docstrings in utils
1 parent 6a0b097 commit fdcbf36

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ adheres to [Semantic Versioning](https://semver.org/).
2424
tradeoff defaulting to keeping the last 8 LZMA decompressors used
2525
- Typing: use `BinaryIO` instead of `IO[bytes]`
2626

27+
### :house: Internal
28+
29+
- Minor improvements in some docstrings
30+
2731
## [0.3.1] - 2021-12-26
2832

2933
[0.3.1]: https://github.com/rogdham/python-xz/releases/tag/v0.3.1

src/xz/utils.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ class FloorDict(_MutableMapping[int, T]):
1919
Differences from dict:
2020
- keys must be int
2121
- obj[key] will return the value whose key is the closest one which is lower or equal to key
22-
- obj[key, True] will return the real index of the value in the form (index, obj[key])
2322
"""
2423

2524
def __init__(self) -> None:
@@ -114,7 +113,7 @@ class Foo:
114113
115114
If attribute is "a" and proxy is "b", it proxies to ".a.b".
116115
117-
If the proxy is None, then use a local value instead,
116+
If the proxy value is None, then use a local value instead,
118117
which acts as a temporary storage in the meanwhile.
119118
"""
120119

0 commit comments

Comments
 (0)