(PDOC-283) Fix namespaced symbols #205
Merged
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
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
force-pushed
the
pdoc-283-fix-symbols
branch
from
a18a3ae to
42a643e
Compare
glennsarti
changed the title
15 tasks
donoghuc
approved these changes
Jul 1, 2019
binford2k
reviewed
Jul 1, 2019
| # YARD 0.9.20 changed how dyna_symbols are represented | ||
| # https://github.com/lsegal/yard/commit/225ded9ef38c6d2be5a3b0fc7effbc7d6644768d | ||
| if yard_version >= Gem::Version.new('0.9.20') | ||
| node.source[2..-2] |
There was a problem hiding this comment.
This seems like a really fragile way to do this, but I trust your judgement that there's not a better way.
There was a problem hiding this comment.
Yeah I wasn't super happy with it. But it's no worse than the examples above or below 🤷♂️ The fragility is also why I add tests so at least we should be able to detect when it goes bad.
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
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 Puppetdocumentation the name should appears as
foo::bar.This commit also adds tests for this scenario as there were no existing tests
for this.