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.
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]`.
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.
Closing on grounds of apparently not really being an issue as opposed to a misunderstanding on my part, as mentioned above.
History
Date
User
Action
Args
2022-04-11 14:59:13
admin
set
github: 80671
2020-03-04 10:58:46
CAM-Gerlach
set
status: open -> closedresolution: not a bugmessages: + stage: needs patch -> resolved
2019-11-02 11:26:40
CAM-Gerlach
set
messages: +
2019-04-05 18:33:48
terry.reedy
set
title: Modernize function signature format in Archiving section of shutil doc -> Modernize function signature in Archiving section of shutil docstage: needs patch
