[issue35155] Clarify Protocol Handlers in urllib.request Docs

Change by Terry J. Reedy : -- resolution: -> fixed stage: patch review -> resolved status: open -> closed ___ Python tracker ___

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Irit Katriel added the comment: This seems complete, can it be closed? -- nosy: +iritkatriel ___ Python tracker ___ ___

[issue35155] Clarify Protocol Handlers in urllib.request Docs

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/868581ee7687ad25af70c0cb9cd6a0f2077e6422 --

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Change by miss-islington : -- pull_requests: +12452 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Change by miss-islington : -- pull_requests: +12451 stage: resolved -> patch review ___ Python tracker ___ ___ Python-bugs-list

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Senthil Kumaran added the comment: We could backport this to older versions too. This documentation change is helpful, and backporting this will help with future backport patches against these files. -- status: closed -> open ___ Python tracker

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Change by Denton Liu : -- stage: patch review -> resolved status: open -> closed ___ Python tracker ___ ___ Python-bugs-list

[issue35155] Clarify Protocol Handlers in urllib.request Docs

miss-islington added the comment: New changeset dd7c4ceed90792f711347024852d4cf883a9ab9e by Miss Islington (bot) (Denton Liu) in branch 'master': bpo-35155: clarify protocol handler method naming (GH-10313) https://github.com/python/cpython/commit/dd7c4ceed90792f711347024852d4cf883a9ab9e

[issue35155] Clarify Protocol Handlers in urllib.request Docs

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 ___

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Denton Liu added the comment: Unfortunately, inline markup can't be combined with roles. Using asterisks, it shows up as `**_open()` and using braces, `{}_open`. I'm not sure how this works but it _might_ be possible to change how :meth: role is interpreted but I believe that's outside the

[issue35155] Clarify Protocol Handlers in urllib.request Docs

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

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Denton Liu added the comment: I gave that a try but it seems like it just outputs the {} literally in the case of the method role. -- ___ Python tracker ___

[issue35155] Clarify Protocol Handlers in urllib.request Docs

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

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Terry J. Reedy added the comment: unittest is another module with half-fixed and half-variable names. The default (glob) pattern for test module names is given as "test*.py". The fixed pattern for test methods is given as "starts with 'test'". This could have been given, I believe, as re

[issue35155] Clarify Protocol Handlers in urllib.request Docs

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 ``_`` method for a placeholder - .proxy and .proxy, with the latter explaining what

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Matthew Barnett added the comment: You could italicise the "protocol" part using asterisks, like this: *protocol*_request or this: *protocol*\ _request depending on the implementation of the rst software. -- nosy: +mrabarnett ___ Python tracker

[issue35155] Clarify Protocol Handlers in urllib.request Docs

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 '' instead of 'placeholder' the best choice? See the PR and answer there. -- nosy: +cheryl.sabella,

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Denton Liu added the comment: Pinging again for updates. Would appreciate a PR review. Thanks! -- ___ Python tracker ___ ___

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Denton Liu added the comment: Pinging for updates. -- ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue35155] Clarify Protocol Handlers in urllib.request Docs

Change by Denton Liu : -- keywords: +patch pull_requests: +9616 stage: -> patch review ___ Python tracker ___ ___ Python-bugs-list

[issue35155] Clarify Protocol Handlers in urllib.request Docs

New submission from Denton Liu : The urllib.request documentation that they can add their own protocol handlers, however they are unclear on how they should be named. We should replace instances of things like protocol_request with _request to make it clear that we are literally replacing