classification
Title: Modernize function signature in Archiving section of shutil doc
Type: Stage: needs patch
Components: Documentation Versions: Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: CAM-Gerlach, docs@python, giampaolo.rodola, inada.naoki, tarek
Priority: normal Keywords:

Created on 2019-03-31 04:08 by CAM-Gerlach, last changed 2019-11-02 11:26 by CAM-Gerlach.

Messages (3)
msg339243 - (view) Author: C.A.M. Gerlach (CAM-Gerlach) * Date: 2019-03-31 04:08
In the process of updating the documentation for another issue, I noticed that unlike the rest of the shutil doc (and the Python docs in general, not to mention those of virtually every Python package), all the functions in the [Archiving operations section](https://docs.python.org/3/library/shutil.html#archiving-operations) uses the old style, difficult to parse nested-bracket notation for the function signatures, rather then the modern style displaying them as they would be expected to appear in Python code, with clearly and explicitly indicated defaults.

Therefore, given all bracketed items are keyword arguments with defaults, and there are no cases more complex then the standard linearly-nested brackets, is there a particular reason why this was retained? Otherwise, I can go ahead and submit a PR to update this.
msg339279 - (view) Author: Inada Naoki (inada.naoki) * (Python committer) Date: 2019-04-01 05:37
I don' think they are modern-style vs legacy-style.

When explicit default value is present, the default value is documented in signature like `param=42`.
On the other hand, when default value is not explicit (just an placeholder), the parameter is expressed using optional group `[param]`.
msg355866 - (view) Author: C.A.M. Gerlach (CAM-Gerlach) * Date: 2019-11-02 11:26
Sorry for the lack of response on this one; it just slipped off my radar. It seems quite clear that my understanding was incomplete as to why the signatures were expressed this way. As such, I presume this can just be closed as NOTABUG? I'll close in a week (assuming I remember) if I don't hear otherwise or someone else doesn't first. Thanks and sorry for bothering folks on this.
History
Date User Action Args
2019-11-02 11:26:40CAM-Gerlachsetmessages: + msg355866
2019-04-05 18:33:48terry.reedysettitle: Modernize function signature format in Archiving section of shutil doc -> Modernize function signature in Archiving section of shutil doc
stage: needs patch
2019-04-01 05:37:22inada.naokisetnosy: + inada.naoki
messages: + msg339279
2019-03-31 06:19:40xtreaksetnosy: + giampaolo.rodola, tarek
2019-03-31 04:08:08CAM-Gerlachcreate