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

doc comments should see through attributes #11498

Open
kjeremy opened this issue Sep 13, 2024 · 0 comments
Open

doc comments should see through attributes #11498

kjeremy opened this issue Sep 13, 2024 · 0 comments
Labels

Comments

@kjeremy
Copy link
Contributor

kjeremy commented Sep 13, 2024

Describe the bug

I have a file that defines some functions with associates doc comments:

lib-impl.nix:

{
  /**
    Describe myFunc
  */
  myFunc = x: ...
}

and a default.nix:

{
  inherit (import ./lib-impl.nix {})
    myFunc;
}

In the repl :doc lib.myFunc does not report any documentation.

Expected behavior

Since there's no documentation in the "outer" scope it should be inherited.

nix-env (Nix) 2.24.5

Additional context

Add any other context about the problem here.

Priorities

Add 👍 to issues you find important.

@kjeremy kjeremy added the bug label Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant