Rubydoc missing curly brace characters
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- ruby
- Domain
- documentation
Research direction
Start with lib/parser/source/tree_rewriter.rb at line 46 and compare its documented example with the rendered Rubydoc page for TreeRewriter. Investigate how the Rubydoc rendering handles content inside curly braces; done means the :hello text and curly-brace characters appear correctly in the generated documentation.
Written by the indexing model from the issue text.
Description
I was reading through the documentation on Rubydoc:
https://www.rubydoc.info/gems/parser/Parser/Source/TreeRewriter
If you read the heading of "Multiple actions at the same end points:", it says:
The resulting string will be
'puts(=> [:everybody])'
The :hello is missing.
When I look at the github source code, the :hello is there: https://github.com/whitequark/parser/blob/master/lib/parser/source/tree_rewriter.rb#L46
It seems Rubydoc will remove things wrapped inside the curly brace {}.
Not sure how this can be mitigated though.
- Dominant language
- Yacc
- Stars
- 1.6k
- Forks
- 205
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from whitequark/parser
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
whitequark/parser#1084 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
whitequark/parser#1075 · 5 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
whitequark/parser#1063 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 50/100
whitequark/parser#1059 ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
whitequark/parser#1046 · 36 comments · 1 reaction ·
All issues in whitequark/parser
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bancolombia/sentinel#22 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
objectionary/hone-maven-plugin#1061 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
redhat-developer/rhdh-plugins#4887 · 2 comments ·