slotThe
commented
1 year ago Thank you!
There are quite a few other warnings about "could not find link destinations for:", but weirdly enough, if I undo the change, the broken link from SpawnOnce is not reported AFAICT, and all the missing "link destinations" that I checked are simply not turned into hyperlinks.
If there's interest, I could try to find and fix all the existing hyperlinks that are broken.
If you want to do that, that would be most appreciated!
* [ ] I updated the `CHANGES.md` file(I assume that the change is minor enough that CHANGES.md doesn't need to be changed.)
:+1:
Sorry for the tiny doc change, but it annoyed me. :)
tl;dr: haddock module links need
"not'.Description
This fixes the broken link on the doc page for XMonad.Util.SpawnOnce to SessionStart.
Haddock interprets 'XMonad.Util.SessionStart' as a (non-existent) function in "XMonad.Util", rather than as a module, and hence it links to:
https://hackage.haskell.org/package/xmonad-contrib-0.17.1/docs/XMonad-Util.html#v:SessionStart
which doesn't exist, rather than to:
https://hackage.haskell.org/package/xmonad-contrib-0.17.1/docs/XMonad-Util-SessionStart.html
Apparently, module links need " instead of '. (See:
https://haskell-haddock.readthedocs.io/en/latest/markup.html#linking-to-modules
)
Checklist
[x] I've read CONTRIBUTING.md
[x] I've considered how to best test these changes (property, unit, manually, ...) and concluded: tested with
cabal haddockand checked link forXMonad-Util-SpawnOnce.html.There are quite a few other warnings about "could not find link destinations for:", but weirdly enough, if I undo the change, the broken link from SpawnOnce is not reported AFAICT, and all the missing "link destinations" that I checked are simply not turned into hyperlinks.
If there's interest, I could try to find and fix all the existing hyperlinks that are broken.
CHANGES.mdfile(I assume that the change is minor enough that CHANGES.md doesn't need to be changed.)