From: "henrikhodne (Henrik Hodne)" <me@...>
Date: 2013-08-04T07:44:39+09:00
Subject: [ruby-core:56367] [ruby-trunk - Bug #8729][Open] Fix character literals in documentation


Issue #8729 has been reported by henrikhodne (Henrik Hodne).

----------------------------------------
Bug #8729: Fix character literals in documentation
https://bugs.ruby-lang.org/issues/8729

Author: henrikhodne (Henrik Hodne)
Status: Open
Priority: Normal
Assignee: zzak (Zachary Scott)
Category: doc
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


=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


-- 
http://bugs.ruby-lang.org/