[issue37134] Use PEP570 syntax in the documentation

miss-islington added the comment: New changeset dba4448c63b687204813a5b04c89dd458d5ac45b by Miss Islington (bot) in branch '3.8': bpo-37134: Add PEP570 notation to the signature of byte{array}.translate (GH-13874)

[issue37134] Use PEP570 syntax in the documentation

Change by miss-islington : -- pull_requests: +13753 pull_request: https://github.com/python/cpython/pull/13875 ___ Python tracker ___

[issue37134] Use PEP570 syntax in the documentation

Pablo Galindo Salgado added the comment: New changeset de76c07a8cd0216c3dce215e4d542e2f45aa022f by Pablo Galindo in branch 'master': bpo-37134: Add PEP570 notation to the signature of byte{array}.translate (GH-13874)

[issue37134] Use PEP570 syntax in the documentation

Change by Pablo Galindo Salgado : -- pull_requests: +13752 pull_request: https://github.com/python/cpython/pull/13874 ___ Python tracker ___

[issue37134] Use PEP570 syntax in the documentation

STINNER Victor added the comment: It seems like the translate() method of bytes and bytearray also needs a "/" in their doc. I wrote a quick & dirty script to parse C files: --- import glob def parse(filename): clinic_input = False args = False positional = False func = None

[issue37134] Use PEP570 syntax in the documentation

Pablo Galindo Salgado added the comment: Thanks Brian for the prototype! I will close this now. We can reopen if something is missing in the future. -- resolution: -> fixed stage: patch review -> resolved status: open -> closed ___ Python tracker

[issue37134] Use PEP570 syntax in the documentation

Guido van Rossum added the comment: Thanks Brian! -- ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue37134] Use PEP570 syntax in the documentation

Brian Skinn added the comment: :thumbsup: Glad I happened to be in the right place at the right time to put it together. I'll leave the tabslash repo up for future reference. -- ___ Python tracker

[issue37134] Use PEP570 syntax in the documentation

Carol Willing added the comment: @brian, Just to echo Brett's words, the Steering Council appreciated the tabbed prototype and your effort to create it. While we may not use it in this particular case, it's great to keep in mind for other places. Thanks for contributing :D --

[issue37134] Use PEP570 syntax in the documentation

Brett Cannon added the comment: @Brian: And thanks for the experiment! It was an interesting idea to consider. -- ___ Python tracker ___

[issue37134] Use PEP570 syntax in the documentation

Brett Cannon added the comment: @Brian: Probably not. The worry that came up during the steering council meeting was bifurcating the docs could cause confusion as to why it was different, which one was more "right", etc. -- ___ Python tracker

[issue37134] Use PEP570 syntax in the documentation

Brian Skinn added the comment: Brett, to be clear, this sounds like the tabbed solution is not going to be used at this point? If so, I'll pull down the tabbed docs I'm hosting. -- ___ Python tracker

[issue37134] Use PEP570 syntax in the documentation

miss-islington added the comment: New changeset 23f41a64ea668296fa89e25f3cfa11f63026ecac by Miss Islington (bot) in branch '3.8': bpo-37134: Use PEP570 syntax for sum() (GH-13851) https://github.com/python/cpython/commit/23f41a64ea668296fa89e25f3cfa11f63026ecac -- nosy:

[issue37134] Use PEP570 syntax in the documentation

Change by miss-islington : -- pull_requests: +13730 pull_request: https://github.com/python/cpython/pull/13854 ___ Python tracker ___

[issue37134] Use PEP570 syntax in the documentation

Pablo Galindo Salgado added the comment: New changeset c4c421d619baf2ff2f7e09f55b7ae22b8f863c7b by Pablo Galindo in branch 'master': bpo-37134: Use PEP570 syntax for sum() (GH-13851) https://github.com/python/cpython/commit/c4c421d619baf2ff2f7e09f55b7ae22b8f863c7b --

[issue37134] Use PEP570 syntax in the documentation

Change by Pablo Galindo Salgado : -- pull_requests: +13728 pull_request: https://github.com/python/cpython/pull/13851 ___ Python tracker ___

[issue37134] Use PEP570 syntax in the documentation

Guido van Rossum added the comment: IIUC sum() should also have a slash in the middle. -- nosy: +gvanrossum ___ Python tracker ___

[issue37134] Use PEP570 syntax in the documentation

Change by Gregory P. Smith : -- nosy: -gregory.p.smith ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue37134] Use PEP570 syntax in the documentation

Carol Willing added the comment: New changeset 54edb04aa688c8247570b4f59b5145e3fa417576 by Carol Willing (Pablo Galindo) in branch 'master': bpo-37134: Add PEP570 notation to the documentation (GH-13743) https://github.com/python/cpython/commit/54edb04aa688c8247570b4f59b5145e3fa417576

[issue37134] Use PEP570 syntax in the documentation

Pablo Galindo Salgado added the comment: Thank you very much, everyone, for sharing your comments, views and concerns and thanks to the steering council for helping to reach a conclusion. I have updated PR13743 to only modify the functions that fall into the second point of Brett's message

[issue37134] Use PEP570 syntax in the documentation

Change by STINNER Victor : -- nosy: +vstinner ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue37134] Use PEP570 syntax in the documentation

Change by STINNER Victor : -- nosy: -vstinner ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue37134] Use PEP570 syntax in the documentation

Brett Cannon added the comment: 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

[issue37134] Use PEP570 syntax in the documentation

Brian Skinn added the comment: First, for anyone interested, there are screenshots and links to docs versions at the SC GH issue (https://github.com/python/steering-council/issues/12#issuecomment-498856524, and following) where we're exploring what the tabbed approach to the PEP570 docs

[issue37134] Use PEP570 syntax in the documentation

Serhiy Storchaka added the comment: You need to use the PEP 570 syntax if your function/method have a var-keyword parameter, takes arbitrary keyword arguments, and has other parameters beside the var-keyword parameter ("self" counts). And of course the minimal supported Python version

[issue37134] Use PEP570 syntax in the documentation

Grant Jenks added the comment: Pablo, I never intended disrespect toward you personally. And I am sorry my words came across that way. I would rather the feature be one of Python's more esoteric qualities. I think Carol has described the most reasonable way forward. And in particular, I

[issue37134] Use PEP570 syntax in the documentation

STINNER Victor added the comment: Tim Peters: "I haven't looked at anything in this PR, so just popping in to confirm that the first time I saw stuff like: len(obj, /) in the docs I had no idea at all what it was trying to say. I thought it was a typo. (...)" Carol Willing: "I confess that

[issue37134] Use PEP570 syntax in the documentation

Julien Palard added the comment: FWIW here's my feedback (as a Python teacher and doc guy): I find that newcomers are good to ignore what they don't understand, so a newcomer exposed to "foo(a, b, /)" will no run away nor cry, he will just ignore the slash and understand that "foo takes two

[issue37134] Use PEP570 syntax in the documentation

Change by Pablo Galindo Salgado : -- title: [EASY] Use PEP570 syntax in the documentation -> Use PEP570 syntax in the documentation ___ Python tracker ___

[issue37134] Use PEP570 syntax in the documentation

Change by STINNER Victor : -- keywords: -easy title: [EASY] Use PEP570 syntax in the documentation -> Use PEP570 syntax in the documentation ___ Python tracker ___

[issue37134] Use PEP570 syntax in the documentation

New submission from Pablo Galindo Salgado : In the documentation, there are a lot of mismatches regarding function and method signatures that use positional-only arguments with respect to the docstrings (that properly use PEP570 syntax for documenting positional-only parameters). Not that