Project

General

Profile

Actions

Bug #17620

closed

doc: StringScanner: incorrect rendering

Added by akim (Akim Demaille) almost 4 years ago. Updated almost 4 years ago.

Status:
Closed
Assignee:
-
Target version:
-
[ruby-core:102447]

Description

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.

Actions #1

Updated by jeremyevans (Jeremy Evans) almost 4 years ago

  • Status changed from Open to Closed

Applied in changeset git|c03b723f56c9b31fb566d83ebecaeae5860b78dd.


Update class documentation for StringScanner

The [] wasn't being displayed, and try to fix formatting for bol?
and << (even if they aren't linked).

Fixes [Bug #17620]

Actions

Also available in: Atom PDF

Like0
Like0