diff --git a/modules/dream2nix/python-editables/interface.nix b/modules/dream2nix/python-editables/interface.nix index 6df479d8..9f5ea0a9 100644 --- a/modules/dream2nix/python-editables/interface.nix +++ b/modules/dream2nix/python-editables/interface.nix @@ -7,10 +7,24 @@ in { options = { editables = lib.mkOption { + description = '' + An attribute set mapping package names to absolute paths of source directories + which should be installed in editable mode in [editablesShellHook](#pipeditablesshellhook). + i.e. + + ``` + pip.editables.charset-normalizer = "/home/user/src/charset-normalizer". + ``` + + The top-level package is added automatically. + ''; type = t.attrsOf t.str; }; editablesShellHook = lib.mkOption { + description = '' + A shellHook to be included into your devShells to install [editables](#pipeditables) + ''; type = t.str; readOnly = true; };