Message344753
To help short-circuit this discussion and focus on the desired solution, the steering council came to a decision that can be seen at https://github.com/python/steering-council/issues/12#issuecomment-498874939 :
- for Python 3.8 specifically, we think it makes sense to continue to leave the slashes out of the documentation for the all parameters are positional-only case (i.e. "... , /)") and the all parameters are positional-only & keyword-only case (i.e. "..., /, *, ..." and "..., /, *args, ..."). This question can then be revisited for Python 3.9.
- however, we actively want to see them added for the cases where an API has a mixture of positional-only and positional-or-keyword args (i.e. "..., /, ...")
- we'd like to see the rendered documentation for function signatures enhanced to use tooltips to name the positional-only (bare "/"), keyword-only (bare "*"), additional positional args (named "*"), and additional keyword args (named "**") notations (hyperlinking to a glossary entry could also be interesting, but may be too visually noisy based on how the hyperlinks get rendered) |
|
Date |
User |
Action |
Args |
2019-06-05 17:35:47 | brett.cannon | set | recipients:
+ brett.cannon, tim.peters, barry, rhettinger, gregory.p.smith, ncoghlan, vstinner, docs@python, serhiy.storchaka, willingc, mdk, bskinn, p-ganssle, pablogsal, grantjenks |
2019-06-05 17:35:47 | brett.cannon | set | messageid: <1559756147.05.0.127952475429.issue37134@roundup.psfhosted.org> |
2019-06-05 17:35:47 | brett.cannon | link | issue37134 messages |
2019-06-05 17:35:46 | brett.cannon | create | |
|