Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't print capabilities for type params when generating docs #2184

Merged
merged 1 commit into from Aug 21, 2017

Commits on Aug 21, 2017

  1. Don't print capabilities for type params when generating docs

    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 committed Aug 21, 2017
    Copy the full SHA
    59050d2 View commit details
    Browse the repository at this point in the history