[前][次][番号順一覧][スレッド一覧]

ruby-changes:71738

From: Peter <ko1@a...>
Date: Fri, 15 Apr 2022 16:07:25 +0900 (JST)
Subject: [ruby-changes:71738] a0eb4b14d6 (master): [ruby/nkf] Fix docs

https://git.ruby-lang.org/ruby.git/commit/?id=a0eb4b14d6

From a0eb4b14d68f77b7efa560e0c1b7d261654c586e Mon Sep 17 00:00:00 2001
From: Peter Zhu <peter@p...>
Date: Wed, 13 Apr 2022 14:09:50 -0400
Subject: [ruby/nkf] Fix docs

rdoc parses "Z[0-3]" as a link to "0-3", this commit escapes these so
that they don't become links.

https://github.com/ruby/nkf/commit/269c10061b
---
 ext/nkf/nkf.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/ext/nkf/nkf.c b/ext/nkf/nkf.c
index 533f9b782f..a8fd937c31 100644
--- a/ext/nkf/nkf.c
+++ b/ext/nkf/nkf.c
@@ -274,7 +274,7 @@ rb_nkf_guess(VALUE obj, VALUE src) https://github.com/ruby/ruby/blob/trunk/ext/nkf/nkf.c#L274
  *
  *  {de/en}crypt ROT13/47
  *
- *  === -h[123] --hiragana --katakana --katakana-hiragana
+ *  === \-h[123] --hiragana --katakana --katakana-hiragana
  *
  *  [-h1 --hiragana] Katakana to Hiragana conversion.
  *
@@ -299,7 +299,7 @@ rb_nkf_guess(VALUE obj, VALUE src) https://github.com/ruby/ruby/blob/trunk/ext/nkf/nkf.c#L299
  *
  *  New line preserving line folding.
  *
- *  === -Z[0-3]
+ *  === \-Z[0-3]
  *
  *  Convert X0208 alphabet (Fullwidth Alphabets) to ASCII.
  *
@@ -318,7 +318,7 @@ rb_nkf_guess(VALUE obj, VALUE src) https://github.com/ruby/ruby/blob/trunk/ext/nkf/nkf.c#L318
  *  With <b>-x</b>, try to preserve X0208 kana and do not convert X0201 kana to X0208.
  *  In JIS output, ESC-(-I is used. In EUC output, SSO is used.
  *
- *  === -B[0-2]
+ *  === \-B[0-2]
  *
  *  Assume broken JIS-Kanji input, which lost ESC.
  *  Useful when your site is using old B-News Nihongo patch.
@@ -336,7 +336,7 @@ rb_nkf_guess(VALUE obj, VALUE src) https://github.com/ruby/ruby/blob/trunk/ext/nkf/nkf.c#L336
  *
  *  Delete \r in line feed, Add \r in line feed.
  *
- *  === -m[BQN0]
+ *  === \-m[BQN0]
  *
  *  MIME ISO-2022-JP/ISO8859-1 decode. (DEFAULT)
  *  To see ISO8859-1 (Latin-1) -l is necessary.
@@ -365,7 +365,7 @@ rb_nkf_guess(VALUE obj, VALUE src) https://github.com/ruby/ruby/blob/trunk/ext/nkf/nkf.c#L365
  *  Input and output code is ISO8859-1 (Latin-1) and ISO-2022-JP.
  *  <b>-s</b>, <b>-e</b> and <b>-x</b> are not compatible with this option.
  *
- *  === -L[uwm]
+ *  === \-L[uwm]
  *
  *  new line mode
  *  Without this option, nkf doesn't convert line breaks.
-- 
cgit v1.2.1


--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]