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

[Inada Naoki]

Inada Naoki  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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Karthikeyan Singaravelan]

Change by Karthikeyan Singaravelan :


--
nosy: +giampaolo.rodola, tarek

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[C.A.M. Gerlach]

New submission from C.A.M. Gerlach :

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 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com