Repository navigation
edit zipfile documentation for consistency #102190
Description
Documentation
there are a few methods in zipfile where args are not explained in the method docstring for public methods. e.g., pwd arg is not explained here: https://github.com/python/cpython/blob/main/Lib/zipfile/__init__.py#L1520, but is documented in a few other public methods.
it's possible to find out what pwd is with a little bit of digging, but it would be helpful to have it defined in the method. it seems like pwd is the most consistently undefined one across zipfile, but i'd be happy to look for other ones as well.
volunteering myself to take care of this work, will open a PR shortly.
Activity
dlwrnc commentedon Mar 21, 2023
one-month ping on this. :)
dlwrnc commentedon Mar 31, 2024
ping on this issue <3. I forgot about it and then got bit again by it this week.
gh-102190: Add additional zipfile `pwd=` arg docstrings (gh-102195)
pythongh-102190: Add additional zipfile `pwd=` arg docstrings (python…
erlend-aasland commentedon Mar 31, 2024
Are there more actionable items left, or can we close this?
dlwrnc commentedon Mar 31, 2024
good to close 👍 I'll probably open another issue at some point to tidy up the rest of the zipfile docstrings, but that's out of the scope of this one.
[3.12] gh-102190: Add additional zipfile `pwd=` arg docstrings (gh-10…
Squashed commit of the following:
Squashed commit of the following:
pythongh-102190: Add additional zipfile `pwd=` arg docstrings (python…