pip guides, docs devshell fix #1013
Conversation
phaer
commented
Jul 11, 2024
•
phaer
commented
- pillow example
- python-local-development example
- devshell with editables
- editables options docs
- pdm example & comparision
- more elaborate flattenDependencies option docs
|
@purepani For some reason, I can't select you as reviewer here, but this might be of interest to you :) |
There was a problem hiding this comment.
I'm generally of the opinion that "getting started" guides should have a super simple example that people generally copy and build off of, so maybe we could simplify the "mytool" example a bit, though I'd maybe just push this as it is for now since that is fixable later.
Also I'm not exactly sure what the name of the second example is. I remember changing it from "my-tool" to "mytool" or something since the hyphen caused issues, so we should make sure that is consistent.
| src = lib.cleanSourceWith { # (5) | ||
| src = lib.cleanSource ./.; | ||
| filter = name: type: | ||
| !(builtins.any (x: x) [ | ||
| (lib.hasSuffix ".nix" name) | ||
| (lib.hasPrefix "." (builtins.baseNameOf name)) | ||
| (lib.hasSuffix "flake.lock" name) | ||
| ]); | ||
| }; |
There was a problem hiding this comment.
I'm not sure if we should include the filtering of the source in this example, since it's not really needed in a "getting started" guide, and most people would probably take this example and copy paste it.
There was a problem hiding this comment.
Yes, it's a good question. The exaple here is, as you probably noticed, a verbatim copy of the python-local-development one in ./examples. If we remove it here, I'd prefer to remove it over there as well for consistency.
On one hand i can see that it opens too many topics at once for people, on the other hand getting an idea of whats copied to the nix store when is important to have any change of understanding why a rebuild happens - even more so with devshells.
I see if i manage to do a better explanation on that, or otherwise remove it for now.
phaer
force-pushed
the
guides
branch
2 times, most recently
from
343ff80
to
60582c3
Compare
in getting-started
as deps is introduced in pip, where it's actually needed
...wasn't updated after function changes in nix-community@9448df1
remove tree-style preprocessing since it is not needed anymore
Keep naming consitant, so that nix run .# and friends work
|
|
||
| We recommend reading our [Getting Started](./getting-started.md) guide first if you have not done so yet! | ||
|
|
||
| this guide we are going to take a look at two annotated examples using the [pip module](../reference/pip/index.md): |
There was a problem hiding this comment.
Hate to point this out right after you pushed, but I think this missing an "In" at the beginning of the sentence!
There was a problem hiding this comment.
Haha, right. No worries, I'll fix it with the next PR, probably later "today" (I am in CEST).
