Bug #8729: Fix character literals in documentation

• Status: Rejected
• Assignee: zzak (zzak _)
• Target version: -
• ruby -v: ruby 2.1.0dev (2013-07-26 trunk 42177) [x86_64-darwin12.4.0]
• Backport: 1.9.3: UNKNOWN, 2.0.0: UNKNOWN

[henrikhodne (Henrik Hodne)]

=begin
(('('))This is my first ever patch to Ruby, tried to follow ((<this guide|URL:http://documenting-ruby.org/step-by-step-guide.html>)), hopefully I did everything right.((')'))

The RDoc tool seems to strip out the (({?})) in character literals, so (({?a})) turns into just (({a})). Not sure if this is the right way to fix it, but I went through files using this ag command to find places where a character literal was used:

ag "\s** .[ (,]?\w" **/.c

Prepending (({?})) to each character literal seemed to fix it, as only one (({?})) is stripped. My guess is that RDoc reads them as character literals and turns them into the characters they represent somehow?
=end

[zzak (zzak _)]

• Status changed from Open to Rejected

This is a bug in RDOc, thank you for your patch but I cannot accept it.