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.

Sign up for GitHub

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 projectDir dependencies #476

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document projectDir dependencies #476

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions modules/types/poetry.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ in {
description = lib.mdDoc ''
Path to the root of the poetry project that provides this ${kernelName}
kernel.

This poetry project must have the required kernel as a dependency.
Copy link

Choose a reason for hiding this comment

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

Add an illustrative example of the most common case

Suggested change
This poetry project must have the required kernel as a dependency.
This poetry project must have the required kernel as a dependency.
For instance, for a Python kernel, you need the `ipykernel` package.

You can also add your own dependencies to it, and they will end up in the resulting environment.
'';
};

Expand Down Expand Up @@ -100,6 +103,8 @@ in {
example = lib.literalExpression "true";
description = lib.mdDoc ''
Use wheels rather than sdist as much as possible.

This may be a viable workaround when packages do not build with Nix but there are wheels available.
'';
};

Expand Down