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.

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

lib.types does not reveal all types #335

Open
JeremiahSecrist opened this issue Sep 12, 2024 · 4 comments
Open

lib.types does not reveal all types #335

JeremiahSecrist opened this issue Sep 12, 2024 · 4 comments
Labels
bug Something isn't working

Comments

@JeremiahSecrist
Copy link

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):

  • OS: nixos
  • Browser Firefox
  • Version: 1.0.0-a.39
@JeremiahSecrist JeremiahSecrist added the bug Something isn't working label Sep 12, 2024
@hsjobeki
Copy link
Collaborator

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
Copy link
Author

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
Copy link
Collaborator

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
Copy link
Author

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants