Skip to content

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

Open

Description

@yav

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

Activity

  1. michaelpj commented on Feb 21, 2024

    @michaelpj
    Collaborator

    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 🤔

  2. jhrcek commented on Feb 23, 2024

    @jhrcek
    Collaborator

    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: haskell/haddock#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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions