Fix docs tooltip for base libraries on Windows #814
Conversation
CHANGELOG.md
Outdated
| @@ -1,4 +1,26 @@ | |||
| ### unreleased | |||
| ### 0.4.0 (2020-09-15) | |||
There was a problem hiding this comment.
I don't think this should end up in this diff.
There was a problem hiding this comment.
I accidentally branched off latest / 0.4.0 prerelease , guess this PR won't get into 0.4 anyway so can just wait until Pepe's commit get into master
| -- canonicalize located html to remove /../ indirection which can break some clients | ||
| -- (vscode on Windows at least) | ||
| htmls' <- traverse canonicalizePath htmls | ||
| return $ listToMaybe htmls' |
There was a problem hiding this comment.
This code applies doesFileExist/canonicalizePath to a sequence of items, then only takes the first. Yuk. That means we are paying for more IO operations that we need. Can we change the filterM to be a findM, then we have a Maybe FIlePath, you can still traverse it to canonicalise, but now we only canonicalize one element, and can skip the listToMaybe.
(I appreciate this wasn't your code to begin with, but a good thing to fix)
There was a problem hiding this comment.
Did only the easy change so far, will look into testability a bit later
Thanks for the hint re findM, didn't know it (will take it as reminder to use Hoogle more often). I also had a thought about potentially wasteful IO on file exists/canonicalize , my naive intuition was that laziness will take care of it (which is not the case as it turned out)
|
And thanks for the diff - its super helpful - I've encountered this issue on Windows too and it was a pain! |
|
very happy to see contributions for Windows, many thanks @DunetsNM |
* Prepare for release 0.4.0 * lookup haddock dir via haddockInterfaces * Fix broken base libraries documentation on Windows * use findM to get just first existing file Co-authored-by: Pepe Iborra <pepeiborra@gmail.com>
* Prepare for release 0.4.0 * lookup haddock dir via haddockInterfaces * Fix broken base libraries documentation on Windows * use findM to get just first existing file Co-authored-by: Pepe Iborra <pepeiborra@gmail.com>
* Prepare for release 0.4.0 * lookup haddock dir via haddockInterfaces * Fix broken base libraries documentation on Windows * use findM to get just first existing file Co-authored-by: Pepe Iborra <pepeiborra@gmail.com>
* Prepare for release 0.4.0 * lookup haddock dir via haddockInterfaces * Fix broken base libraries documentation on Windows * use findM to get just first existing file Co-authored-by: Pepe Iborra <pepeiborra@gmail.com>
This fixes #769 , see the issue thread for details