Denton Liu added the comment: Pinging for updates. ---------- _______________________________________ Python tracker https://bugs.python.org/issue35155 _______________________________________

Terry J. Reedy added the comment: Cheryl, you know rst better than me. Is there any markup to indicate that a word is a placeholder, not meant to be taken literally? Or is Denton's '<placeholder>' instead of 'placeholder' the best choice? See the PR and answer there. ---------- nosy: +cheryl.sabella, orsenthil, terry.reedy versions: -Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker https://bugs.python.org/issue35155 _______________________________________

Cheryl Sabella added the comment: I don't think there is anything specifically defined for a placeholder. However, looking at the current urllib.request documentation, there are 2 places that use the ``<name>_`` method for a placeholder - <protocol>.proxy and <scheme>.proxy, with the latter explaining what <scheme> means.

By default, ProxyHandler uses the environment variables named <scheme>_proxy, where <scheme> is the URL scheme involved.

That line was added by Georg Brandl (granted it was part of converting all the docs), which would lead me to believe that is the accepted way to do it. Also, the argument clinic how-to has the following:

The length of the string will be passed in to the impl function, just after the string parameter, as a parameter named ``_length``.

I'll make a comment on the PR too. ---------- _______________________________________ Python tracker https://bugs.python.org/issue35155 _______________________________________

Cheryl Sabella added the comment: I found this issue that Serhiy did on the devguide where he added {} around the placeholder: https://github.com/python/devguide/pull/444 I think that might be the correct way to do it. ---------- _______________________________________ Python tracker https://bugs.python.org/issue35155 _______________________________________

Terry J. Reedy added the comment: For file names, the result is <name> in italics. Looking at https://devguide.python.org/exploring/, that seems to work well. Can we just use *<name>*? ---------- _______________________________________ Python tracker https://bugs.python.org/issue35155 _______________________________________

Denton Liu added the comment: If there aren't anymore comments, I think this PR is ready for a second round of reviews. Thanks! ---------- _______________________________________ Python tracker https://bugs.python.org/issue35155 _______________________________________

Change by Denton Liu : ---------- stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker https://bugs.python.org/issue35155 _______________________________________

Change by miss-islington : ---------- pull_requests: +12451 stage: resolved -> patch review _______________________________________ Python tracker https://bugs.python.org/issue35155 _______________________________________

miss-islington added the comment: New changeset 868581ee7687ad25af70c0cb9cd6a0f2077e6422 by Miss Islington (bot) in branch '3.7': bpo-35155: clarify protocol handler method naming (GH-10313) https://github.com/python/cpython/commit/868581ee7687ad25af70c0cb9cd6a0f2077... ---------- _______________________________________ Python tracker https://bugs.python.org/issue35155 _______________________________________

Change by Terry J. Reedy : ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker https://bugs.python.org/issue35155 _______________________________________