From: akim.demaille@...
Date: 2021-02-10T14:22:52+00:00
Subject: [ruby-core:102447] [Ruby master Bug#17620] doc: StringScanner:	incorrect rendering

Issue #17620 has been reported by akim (Akim Demaille).

----------------------------------------
Bug #17620: doc: StringScanner: incorrect rendering
https://bugs.ruby-lang.org/issues/17620

* Author: akim (Akim Demaille)
* Status: Open
* Priority: Normal
* Backport: 2.5: UNKNOWN, 2.6: UNKNOWN, 2.7: UNKNOWN, 3.0: UNKNOWN
----------------------------------------
Sorry not to be able to provide a fix, but the documentation of strscan.c reads (https://github.com/ruby/ruby/blob/b5de66e13278ec588cbc8b76b7212e22898e6a89/ext/strscan/strscan.c#L1552):

 * === Match Data
 *
 * - #matched
 * - #matched?
 * - #matched_size
 * - []
 * - #pre_match
 * - #post_match

and the rendering of [] is processed somewhere as a magic escape, which results in a poor rendering:

https://ruby-doc.org/stdlib-3.0.0/libdoc/strscan/rdoc/StringScanner.html#class-StringScanner-label-Match+Data

Cheers.



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

Unsubscribe: <mailto:ruby-core-request@ruby-lang.org?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>