docs: discourage main-subpackage name collisions for multiple outputs:
in define-metadata.rst
#5767
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is an attempt at correcting a misleading wording and providing good guidance for the naming of subpackages when using multiple
outputs:
in ameta.yaml
recipe.For cross-reference, this docs change was noted as being necessary in previous issues:
Also, the previous wording implied that having the top-level name of a recipe repeated in one of the subpackage names. This is exactly the behavior that is cited to cause the unintended side-effects, for example here:
Feel free to further improve the wording, this is mostly meant to get the ball rolling again. Especially since previous efforts to make this name re-use a hard error in
conda-build
have all gone stale, see for example:So this is kind of the minimal fix, something like #3314 would be much nicer in the mid-term. And I guess that in the long-term, this should go away if the new recipe format is fully implemented and enforced, see:
Checklist - did you ...
news
directory (using the template) for the next release's release notes?