Project

General

Profile

Bug #11495

[Documentation] Please improve documentation for Regexp.new() and clarify the 3 argument call

Added by shevegen (Robert A. Heiler) about 5 years ago. Updated over 4 years ago.

Status:
Closed
Priority:
Normal
Target version:
-
[ruby-core:<unknown>]

Description

Hello,

The documentation at Regepx.new here:

http://ruby-doc.org/core-2.2.3/Regexp.html#method-c-new

It shows a lot of information, in particular four ways to call it:

new(string, [options [, kcode]]) -> regexp
new(regexp) -> regexp
compile(string, [options [, kcode]]) -> regexp
compile(regexp) -> regexp

However, the examples given do not show an example of where
3 arguments are passed.

Today this came up on IRC where someone asked how to use
respectively what the meaning of kcode is, via example.

Can someone add an example of where/when to use 3 arguments
to this method please? Thank you.


Files

0001-Improve-documentation-for-Regexp.new.patch (1.55 KB) 0001-Improve-documentation-for-Regexp.new.patch This contains the change for removing [, kcode] dpulliam (Dylan Pulliam), 10/12/2015 12:05 AM

Also available in: Atom PDF