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

(PDOC-283) Fix namespaced symbols #205

Merged
merged 1 commit into from
Jul 1, 2019

Commits on Jul 1, 2019

  1. (PDOC-283) Fix namespaced symbols

    Previously in Yard 0.9.19 dyna_symbols (symbols represented as strings e.g.
    :'something') were converted to their unqualified symbol name e.g. :something.
    However YARD treated this as a bug and in Yard 0.19.20 dynasymbols are now their
    original source.  This commit modifies the base ruby handler to always convert
    dyna_symbols to their plain name, as Puppet uses this for actual documentation
    and Puppet Code.  For example the fully qualified function 'foo::bar' will
    appear in the ruby function definition as `.. :'foo::bar'` however in the Puppet
    documentation the name should appears as `foo::bar`.
    
    This commit also adds tests for this scenario as there were no existing tests
    for this.
    glennsarti committed Jul 1, 2019
    Configuration menu
    Copy the full SHA
    42a643e View commit details
    Browse the repository at this point in the history