[issue36490] Modernize function signature format in Archiving section of shutil doc

New submission from C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>: 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. ---------- assignee: docs@python components: Documentation messages: 339243 nosy: CAM-Gerlach, docs@python priority: normal severity: normal status: open title: Modernize function signature format in Archiving section of shutil doc versions: Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36490> _______________________________________

Change by Karthikeyan Singaravelan <tir.karthi@gmail.com>: ---------- nosy: +giampaolo.rodola, tarek _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36490> _______________________________________

Inada Naoki <songofacandy@gmail.com> added the comment: 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]`. ---------- nosy: +inada.naoki _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36490> _______________________________________

Change by Terry J. Reedy <tjreedy@udel.edu>: ---------- stage: -> needs patch title: Modernize function signature format in Archiving section of shutil doc -> Modernize function signature in Archiving section of shutil doc _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36490> _______________________________________

C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> added the comment: 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. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36490> _______________________________________

C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> added the comment: Closing on grounds of apparently not really being an issue as opposed to a misunderstanding on my part, as mentioned above. ---------- resolution: -> not a bug stage: needs patch -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue36490> _______________________________________
participants (4)
-
C.A.M. Gerlach
-
Inada Naoki
-
Karthikeyan Singaravelan
-
Terry J. Reedy