This repository was archived by the owner on Aug 3, 2024. It is now read-only.
Default signatures #938
Merged
Default signatures #938
Conversation
This file contains hidden or 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
...when the other method is let through.
There is still no plan for documenting these though.
A while back, class methods changed from 'TypeSig' -> 'ClassOpSig'. I also took the opportunity to at least render default signatures.
|
In case it isn't clear, this really a bug fix (although I ended up improving the output along the way too). This is what
Here is what this branch produces instead:
Here is the output of the test cases I added: XHTML default signatures
XHTML default associated types
LaTeX default signatures
|
sjakobi
suggested changes
Sep 11, 2018
| @@ -72,14 +73,14 @@ ppLFunSig :: Bool -> LinksInfo -> SrcSpan -> DocForDecl DocName -> | |||
| [Located DocName] -> LHsType DocNameI -> [(DocName, Fixity)] -> | |||
| Splice -> Unicode -> Maybe Package -> Qualification -> Html | |||
| ppLFunSig summary links loc doc lnames lty fixities splice unicode pkg qual = | |||
| ppFunSig summary links loc doc (map unLoc lnames) lty fixities | |||
| ppFunSig summary links loc mempty doc (map unLoc lnames) lty fixities | |||
There was a problem hiding this comment.
I think it would be better to have something more explicit than mempty here.
| @@ -226,7 +227,7 @@ ppFor :: Bool -> LinksInfo -> SrcSpan -> DocForDecl DocName | |||
| -> Splice -> Unicode -> Maybe Package -> Qualification -> Html | |||
| ppFor summary links loc doc (ForeignImport _ (L _ name) typ _) fixities | |||
| splice unicode pkg qual | |||
| = ppFunSig summary links loc doc [name] (hsSigType typ) fixities splice unicode pkg qual | |||
| = ppFunSig summary links loc mempty doc [name] (hsSigType typ) fixities splice unicode pkg qual | |||
| @@ -503,7 +504,7 @@ ppShortClassDecl summary links (ClassDecl { tcdCtxt = lctxt, tcdLName = lname, t | |||
|
|
|||
| -- ToDo: add associated type defaults | |||
|
|
|||
| [ ppFunSig summary links loc doc names (hsSigType typ) | |||
| [ ppFunSig summary links loc mempty doc names (hsSigType typ) | |||
haddock-api/src/Haddock/GhcUtils.hs
Outdated
| uniquifyClassSig _ = liftA2 setName (updateName . getName) id | ||
| where | ||
| updateName = liftA2 setNameUnique id $ | ||
| liftA2 deriveUnique id ((+1) . getKey) . nameUnique |
There was a problem hiding this comment.
I see several issues with this function but it doesn't appear to be used at all?!
There was a problem hiding this comment.
Hah, nice catch! I thought this was funky too: #822 (comment). This snuck in through the cherry-picked commits.
* remove unused (and buggy) function * 'mempty' -> 'noHtml'
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Adds back rendering of default methods. While I was at it, I also cherry-picked some old un-merged changes to improve the rendering of: default methods & default associated types (in the XHTML backend) and default methods (in the LaTeX backend).
Note there is still some GHC-side work that needs to be done to collect docs on default methods and default associated types. However, this solves the more urgent problem that we currently aren't rendering anything related to defaults.