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

bug: shebang line causes module docs to be omitted #24339

Open
iuioiua opened this issue Jun 26, 2024 · 1 comment
Open

bug: shebang line causes module docs to be omitted #24339

iuioiua opened this issue Jun 26, 2024 · 1 comment
Labels
bug Something isn't working correctly std Affects the Deno Standard Library

Comments

@iuioiua
Copy link
Collaborator

iuioiua commented Jun 26, 2024

To reproduce:

  1. Clone and cd into deno_std.
  2. Generate docs for @std/http/file-server using deno doc --html http/file_server.ts. Note: http/file_server.ts starts contains a shebang line (see here).
  3. Open docs using open docs/index.html and observe there is no module documentation, even though http/file_server.ts contains it (see here).
  4. Remove the shebang line from http/file_server.ts.
  5. Generate and open docs again and observe there is now module documentation.
deno 1.44.4+09cc473 (canary, aarch64-apple-darwin)
v8 12.6.228.9
typescript 5.4.5
@iuioiua iuioiua added bug Something isn't working correctly std Affects the Deno Standard Library labels Jun 26, 2024
@MujahedSafaa
Copy link

I will take a look at this issue

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

No branches or pull requests

2 participants