search

nix-community / noogle

https://noogle.dev - nix function exploring. [maintainer=@hsjobeki]
https://noogle.dev
MIT License
367 stars 11 forks source link

lib.types does not reveal all types #335

Open JeremiahSecrist opened 2 months ago

JeremiahSecrist commented 2 months ago

What happened I'm currently working on adding documentation to lib/types.nix in nixpkgs. Not all lib.types are shown on noogle. I assume this is due to limitations of nixdoc? That being said finding types for use with nixos modules is quite valued. One other question is should I document the types that are not explicit functions In the interim assuming this may get solved in the future.

Steps to Reproduce Steps to reproduce the behavior:

  1. Go to noogle.dev
  2. Compare with here
  3. See the type not present

Expected behavior Expected behavior is all types show up even if not functions.

Desktop (please complete the following information):

hsjobeki commented 2 months ago

Hey thanks for opening this issue. Noogle was built as a search for functions. Those functions that are defined by lib.types should be displayed. But i am also Open to extend the scope carefully and also display a selection of important attributes auch as lib.types.

If you need any help with the documentation just mention me in the nixpkgs PR.

JeremiahSecrist commented 2 months ago

Noogle was built as a search for functions. Those functions that are defined by lib.types should be displayed.

I'm glad you're willing to expand in specific cases such as this! types is something I currently have to frequent when working on nixos modules.

If you need any help with the documentation just mention me in the nixpkgs PR.

i'll be certain to ping when the time comes. there is a lot I can deduce as of right now just by grepping the repo and finding examples uses as i go.

The question remains if I should code comment the non function types in preparation for such a feature?

hsjobeki commented 2 months ago

Documentation for most types is here: https://nixos.org/manual/nixos/stable/#sec-option-types No need to rewrite. We just need to factor it in the long term

JeremiahSecrist commented 2 months ago

Documentation for most types is here: https://nixos.org/manual/nixos/stable/#sec-option-types No need to rewrite. We just need to factor it in the long term

understood! I'll port them over to be as code comments, or are you able to grab them from their directly for noogle?