Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document custom_multichannels #13796

Open
2 of 4 tasks
travishathaway opened this issue Apr 15, 2024 · 0 comments
Open
2 of 4 tasks

Document custom_multichannels #13796

travishathaway opened this issue Apr 15, 2024 · 0 comments
Labels
backlog issue has been triaged but has not been earmarked for any upcoming release source::anaconda created by members of Anaconda, Inc. type::documentation request for improved documentation

Comments

@travishathaway
Copy link
Contributor

travishathaway commented Apr 15, 2024

Checklist

  • I added a descriptive title
  • I searched open reports and couldn't find a duplicate

What happened?

We should document custom_multichannels by demonstrating how to use it on this page:

What should be done?

  • Start with the current explanation here:

    conda/conda/base/context.py

    Lines 1480 to 1490 in 5b77a1c

    custom_multichannels=dals(
    """
    A multichannel is a metachannel composed of multiple channels. The two reserved
    multichannels are 'defaults' and 'local'. The 'defaults' multichannel is
    customized using the 'default_channels' parameter. The 'local'
    multichannel is a list of file:// channel locations where conda-build stashes
    successfully-built packages. Other multichannels can be defined with
    custom_multichannels, where the key is the multichannel name and the value is
    a list of channel names and/or channel urls.
    """
    ),
    simplifying the language where necessary
  • Include an example of how to use it (defaults is a good example)

Additional Context

The lack of its documentation came up on this discussion thread on our discourse server:

@travishathaway travishathaway added type::documentation request for improved documentation source::anaconda created by members of Anaconda, Inc. backlog issue has been triaged but has not been earmarked for any upcoming release labels Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog issue has been triaged but has not been earmarked for any upcoming release source::anaconda created by members of Anaconda, Inc. type::documentation request for improved documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant