https://github.com/lsegal/yard-types-parser

Parses YARD formal type declarations into a human readable format.
https://github.com/lsegal/yard-types-parser

Last synced: about 2 months ago
JSON representation

Parses YARD formal type declarations into a human readable format.

• Host: GitHub
• URL: https://github.com/lsegal/yard-types-parser
• Owner: lsegal
• License: mit
• Created: 2009-06-09T05:01:29.000Z (over 15 years ago)
• Default Branch: master
• Last Pushed: 2022-02-24T18:38:51.000Z (almost 3 years ago)
• Last Synced: 2024-10-31T06:51:32.390Z (2 months ago)
• Language: Ruby
• Homepage: http://yardoc.org/types
• Size: 4.88 KB
• Stars: 9
• Watchers: 4
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
YARD Types Parser

=================

Parses YARD type declarations and translates them into plain English. A quick

example of a YARD type declaration is in the following parameter declaration:

    # @param [Array] arg takes an Array of Strings or Symbols

    def foo(arg)

    end

    

The parser will convert `Array` into the more readable:

    an Array of (Strings or Symbols)

    

You can quickly parse with:

    Parser.new("String, Symbol, false").parse.list_join 

    #=> "a String, a Symbol or false"

    

You can try this yourself live at [http://yard.soen.ca/types](http://yard.soen.ca/types)

with plenty more examples.