doc/custom channels: fix formatting and typo #9623
Conversation
The _Creating custom channels_ doc refers to "using a `file://` URL",
and the conda code uses `urllib.parse.urlsplit` to parse 'file://'
channel references.
A proper `file://`-URI-based reference to a local (linux) file should
include 3 back-to-back slashes (`/`), but the example only uses 2.
The parsing actually goes slightly wrong when used as in the example,
though in a way that (accidentally) doesn't matter:
```
>>> from conda.common.url import path_to_url
>>> path_to_url('/opt/channel')
'file:///opt/channel'
>>> from conda.common.path import url_to_path
>>> url_to_path('file:///opt/channel')
'/opt/channel'
>>> url_to_path('file://opt/channel')
'//opt/channel' <= note extra leading slash
```
Fix the example to specify the file URL properly, and make a minor
formatting tweak in the same section.
|
We require contributors to sign our Contributor License Agreement, and we don't have one on file for @hartb. In order for us to review and merge your code, please e-sign the PDF at https://conda.io/en/latest/contributing.html#conda-contributor-license-agreement. We then need to manually verify your signature. We will ping the bot to refresh the PR status when we have confirmed your signature. |
|
Hello! I signed the CLA just before putting up the PR. Maybe the signature hadn't completely processed yet. Will wait a bit to see if the PR is updated when the signature registers. |
|
I believe the AppVeyor builds' test failures are unrelated to this change: and |
|
@cla-bot check |
|
The cla-bot has been summoned, and re-checked this pull request! |
|
Hi there, thank you for your contribution to Conda! This pull request has been automatically locked since it has not had recent activity after it was closed. Please open a new issue or pull request if needed. |
The Creating custom channels doc refers to "using a
file://URL",and the conda code uses
urllib.parse.urlsplitto parse 'file://'channel references.
A proper
file://-URI-based reference to a local (linux) file shouldinclude 3 back-to-back slashes (
/), but the example only uses 2.The parsing actually goes slightly wrong when used as in the example,
though in a way that (accidentally) doesn't matter:
Fix the example to specify the file URL properly, and make a minor
formatting tweak in the same section.