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

multi-output: document full/lite splits with optional dependencies #2168

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

croth1
Copy link
Contributor

@croth1 croth1 commented May 1, 2024

PR Checklist:

  • note any issues closed by this PR with closing keywords
  • if you are adding a new page under docs/ or community/, you have added it to the sidebar in the corresponding _sidebar.json file
  • put any other relevant information below

Seems to have been done a couple of times already, but was a bit of an adventure for me, so maybe worth putting it into docs.

@croth1 croth1 requested a review from a team as a code owner May 1, 2024 19:53
Copy link

netlify bot commented May 1, 2024

Deploy Preview for conda-forge-previews ready!

Name Link
🔨 Latest commit 939bfbd
🔍 Latest deploy log https://app.netlify.com/sites/conda-forge-previews/deploys/6632a312f517640008d7cf94
😎 Deploy Preview https://deploy-preview-2168--conda-forge-previews.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@croth1 croth1 force-pushed the multioutput_optional_deps branch from 16ecfb6 to 77b9535 Compare May 1, 2024 19:57
README.md Outdated Show resolved Hide resolved
@@ -1655,6 +1655,37 @@ add some information on r packages which make heavy use of `noarch: generic`
- [importlib_metadata and importlib-metadata](https://github.com/conda-forge/importlib_metadata-feedstock/blob/main/recipe/meta.yaml)
- [typing_extensions and typing-extensions](https://github.com/conda-forge/typing_extensions-feedstock/blob/main/recipe/meta.yaml)

### Common patterns

#### Splitting out heavy optional dependencies
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The previous (low-effort) approach for this was to add the example in the list above (under "Distributing the same project with different sets of dependencies"), and then the pitfall in the section below. This section has a bit both, hence the confusion. I'd rather:

  • Add the run_constrained pin_subpackage problem to the pitfalls (link to issue).
  • Add a shorter summary of the solution you are proposing to the aforementioned list to avoid duplicating information. Briefly warn about the pitfall here.

That said, the information you have written here is accurate and I don't want to bikeshed too much. Feel free to ignore my feedback or only take into account parts of it.

Copy link
Contributor Author

@croth1 croth1 May 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmh, fair point, doing it this way is a bit of mess. I found the list structure a bit annoying because it somewhat strongly enforces brevity and discourages explanations beyond a short summary, but it is just a more detailed explanation of a special case of Distributing the same project with different sets of dependencies. Hmm...

@jaimergp jaimergp added the Docs label Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants