Include comments in child declarations in HTML docs - #2981
Merged
Conversation
That is, if doc-comments are provided in a source file for any of the following: - type class members - instance declarations - data constructors they will now be included in the HTML. Fixes purescript/pursuit#159.
paf31
approved these changes
Jul 9, 2017
paf31
left a comment
Contributor
There was a problem hiding this comment.
Do you have some example HTML? I'm curious to see what instances look like.
Looks good!
Contributor
Author
|
Oh of course, yes: http://harry.garrood.me/purs-html-docs-example/Data.Either.html I was previously thinking of making these collapsible (see the Pursuit issue), but since library authors can choose whether to use these or not, I don't think there's too much risk of docs becoming excessively verbose; I think we can and should trust authors to use this appropriately. |
Contributor
|
Looks really good! |
Contributor
Author
|
Thanks :) |
paf31
added a commit
that referenced
this pull request
Jul 10, 2017
…2985) * Revert "Fix child decl ordering (#2984)" This reverts commit 7fdd39d. * Revert "Only build master and semver tags in Travis (#2982)" This reverts commit c41a7a4. * Revert "Include comments in child declarations in HTML docs (#2981)" This reverts commit ad6166f. * Revert "Solve RowToList (#2945)" This reverts commit 0e2d820. * Revert "Fix links to type operators in HTML docs (#2979)" This reverts commit 5fe26f2. * Revert "Re-evaluate REPL globs during :reload (#2978)" This reverts commit 50e1c68. * Revert "[purs ide] Collect data constructors (#2976)" This reverts commit c965f35. * Revert "Replace synonyms in instance constraints (#2973)" This reverts commit ee66e0d. * Revert "Require single-method instance declarations to be indented (#2965)" This reverts commit b3e470d.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
That is, if doc-comments are provided in a source file for any of the
following:
they will now be included in the HTML.
Fixes purescript/pursuit#159.