I noticed that pkgs.mkShell doesn’t have docstrings, so it doesn’t provide any information on Noogle. Suppose I wanted to fix that, by including some information and a reference to here: https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-mkShell. What should I do?
-
Is there some sort of template for adding docstrings to a function? I notice that many of the docstrings have things like a
type
section, or aninput
section. Which of these should be contributed? Is there a standard reference for the type notation? -
Should I just add a docstring and put in a PR?
Sorry for the dumb question. I’ve looked here: Noogle - Simply find Nix API reference documentation. and here: nixpkgs/doc/README.md at 8ca877b3b8a62412386467538fa59fdf64abd4b3 · NixOS/nixpkgs · GitHub, and I still am not sure - the latter has more information, including some advice about input
outputs
and examples
, but nothing about docstrings per se.