Skip to content

Commit

Permalink
Improve WheelFile.filename docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
MrMino committed Aug 5, 2024
1 parent ad84dc2 commit b1fed8a
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions wheelfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -861,12 +861,14 @@ class WheelFile:
Attributes
----------
filename : str
If initialized with:
- An IO buffer: the filename that the wheel would have after saving
it onto filesystem.
- A path to a directory: the path to the wheel, composed from its
the given path and the filename generated using the parameters
given to `__init__`.
Depending on what the class was initialized with, this attribute is either:
- If initialized with an IO buffer: the filename that the wheel
would have after saving it onto filesystem, considering other
parameters given to `__init__`: `distname`, `version`,
`build_tag`, `language_tag`, `abi_tag` and `platform_tag`.
- If initialized with a path to a directory: the path to the wheel
composed from the given path, and the filename that was generated
using other parameters given to `__init__`.
- A path to a file: that path, even if it is not compliant with the
spec (in lazy mode).
Expand Down

0 comments on commit b1fed8a

Please sign in to comment.