Don't print capabilities for type params when generating docs #2184
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
Per #2145 (comment), this shouldn't be allowed as its not legal Pony. As #2145 generally comments on we only want legal code output in the documentation. This addresses the specific issue in #2145, however, there are other instances we might want to expand this to. I decided to limit to this specifically as I think any change we make in other sections of docgen would require a thorough auditing of output documentation to make sure there weren't any unintended consquences. Prior to this change, generated documentation for: ```pony type Set[A: (Hashable #read & Equatable[A] #read)] is HashSet[A, HashEq[A]] ``` would be ```pony type Set[A: (Hashable #read & Equatable[A #read] #read)] is HashSet[A #read, HashEq[A #read] val] ref ``` now it is ``` type Set[A: (Hashable #read & Equatable[A] #read)] is HashSet[A, HashEq[A] val] ref ```
SeanTAllen
added
the
changelog - fixed
mfelsche
approved these changes
Aug 21, 2017
|
Thanks for taking this one. |
jemc
approved these changes
Aug 21, 2017
|
@SeanTAllen yes, I'd expect the issue ticket to be complete after this one. Thanks! |
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.
Per #2145 (comment),
this shouldn't be allowed as its not legal Pony. As #2145 generally
comments on we only want legal code output in the documentation.
This addresses the specific issue in #2145, however, there are other
instances we might want to expand this to. I decided to limit to this
specifically as I think any change we make in other sections of docgen
would require a thorough auditing of output documentation to make sure
there weren't any unintended consquences.
Prior to this change, generated documentation for:
would be
now it is