Bad index in hackage documentation for `lsp-types`?

haskell / lsp

Haskell library for the Microsoft Language Server Protocol

364 stars 91 forks source link

Bad index in hackage documentation for `lsp-types`? #558

Open yav opened 7 months ago

yav commented 7 months ago

There appears to be something wrong with the hackage docs of lsp-types, in particular:

If you open Language.LSP.Protoco.Message and press ctrs-S to search for names, typing Method says that there is no such name. However, if you just use the ordinary "find in page" capability of the browser, the definition of Method is clearly there.
If you click on the index link for lsp-types you get an empty page.
When you browse the docs for lsp, (e.g., Language.LSP.Server), a bunch of the types that come from lsp-types are not hyperlinked (e.g., NormalizedUri, Method, ClientToServer, etc).

michaelpj commented 7 months ago

If you open Language.LSP.Protoco.Message and press ctrs-S to search for names, typing Method says that there is no such name

I wonder if this is because it's a re-export? I know haddock is a bit weird about re-exports sometimes?

I'll see if I can reproduce the others locally and if there are some haddock warnings or something that point at what's wrong :thinking:

jhrcek commented 7 months ago

This is pretty annoying. I often find myself wanting to find (using haddock "search by pressing s" feature) which is currently not possible.

I think it might be due to this haddock issue: https://github.com/haskell/haddock/issues/958

EDIT: I'm unable to reproduce this locally. Doing the following

cd lsp-types
cabal haddock
# open the resulting docs directory in the browser - it contains full index of things
../dist-newstyle/build/x86_64-linux/ghc-9.4.8/lsp-types-2.1.1.0/doc/html/lsp-types/doc-index.html

but then why is this corresponding page on hackage empty? https://hackage.haskell.org/package/lsp-types-2.1.1.0/docs/doc-index.html