Haddock: Pass hyperlink source directory with --read-interface #5212
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I assume you tested this for |
23Skidoo
reviewed
Mar 27, 2018
Cabal/Distribution/Simple/Haddock.hs
Outdated
|
|
||
| haddockPackageFlags :: Verbosity | ||
| -> LocalBuildInfo | ||
| -> ComponentLocalBuildInfo | ||
| -> Maybe PathTemplate | ||
| -> IO ([(FilePath, Maybe FilePath)], Maybe String) | ||
| -> IO ([(FilePath, Maybe FilePath, Maybe FilePath)], Maybe String) |
There was a problem hiding this comment.
Can you please add a Haddock comment to this function? The type sig starts to get a bit unwieldy, esp. the return type.
|
Merged, thanks! |
|
@hvr This changes the type of an exported |
|
@23Skidoo good catch; then we shouldn't cherry-pick... |
|
Backporting in a PVP-compliant way should be easy, though. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With this patch Cabal passes the directory to hyperlinked sources for each package, if present. This helps for package cross-references in hyperlinked-sources.
Please include the following checklist in your PR:
[ci skip]is used to avoid triggering the build bots.Please also shortly describe how you tested your change. Bonus points for added tests!