19 Commits
Author SHA1 Message Date
Earlopain 4b6040ca3e [ruby/strscan] Fix call-seq formatting
(https://github.com/ruby/strscan/pull/203)

They don't work in included markdown and also need a leading `:`

<img width="791" height="442" alt="grafik"
src="https://github.com/user-attachments/assets/eca5d4c2-9597-4c58-a0cc-a4e2c9109992"
/>

https://github.com/ruby/strscan/commit/b504b3b0ad
2026-05-03 21:56:31 +00:00
Peter Zhu 8b0ec6ac5e [ruby/strscan] [DOC] Add doc/.document
(https://github.com/ruby/strscan/pull/199)

There are a lot of files in the doc directory that we do not want RDoc
pages for. Add a doc/.document file to suppress RDoc page generation to
only helper_methods.md.

https://github.com/ruby/strscan/commit/424375112c
2026-03-21 08:47:18 +00:00
Burdette Lamar 37a53b49d8 [ruby/strscan] [DOC] Fix link
(https://github.com/ruby/strscan/pull/198)

https://github.com/ruby/strscan/commit/2de73294d5
2026-03-21 01:03:21 +00:00
Benoit Daloze b012b703c8 [ruby/strscan] Fix documentation of StringScanner#skip_until
(https://github.com/ruby/strscan/pull/196)

I noticed this while working on #195.

https://github.com/ruby/strscan/commit/3dc627db11
2026-03-10 05:25:48 +00:00
Burdette Lamar 900182e265 [ruby/strscan] [DOC] Fix links
(https://github.com/ruby/strscan/pull/190)

https://github.com/ruby/strscan/commit/f6033e5253
2026-02-06 23:34:00 +00:00
Yuki Kurihara a63147eed1 [ruby/strscan] [DOC] Avoid being interpreted as a link
(https://github.com/ruby/strscan/pull/180)

Since `[](n)` is being interpreted as a Markdown link, it cannot be
displayed as a method call.
I have corrected this by escaping the brackets so that they are
interpreted as strings rather than links.

### Before

ri

```
    #{}[n]     |   <tt>n</tt>th captured substring.    |       +nil+.
```

html

<img width="424" height="217" alt="image"
src="https://github.com/user-attachments/assets/b45601ab-ed1c-4b82-b112-325f12bde197"
/>

### After

ri

```
    #[](n)     |   <tt>n</tt>th captured substring.    |       +nil+.
```

html

<img width="489" height="217" alt="image"
src="https://github.com/user-attachments/assets/1212c147-42a5-4f62-8667-a279ccff67a3"
/>

https://github.com/ruby/strscan/commit/b3d56867fd
2025-12-02 22:24:29 +00:00
Berkan Ünal e68fcf111b [ruby/strscan] [DOC] Fix broken link to helper methods
(https://github.com/ruby/strscan/pull/179)

### Helper methods link is broken at master branch

To reproduce
1. go to [StringScanner
docs](https://docs.ruby-lang.org/en/master/StringScanner.html)
2. Click to link at line
   > See examples at **helper_methods**
3. Resolved url gives 404:
https://docs.ruby-lang.org/en/master/strscan/helper_methods_md.html

### Fix

Currently link resolves as `href="doc/strscan/helper_methods_md.html"`
Correct link should be resolved as `href="helper_methods_md.html"`

https://github.com/ruby/strscan/commit/adb8678aa6
2025-12-01 22:02:40 +00:00
Étienne Barrié da3336c52b [ruby/strscan] Fix typo (https://github.com/ruby/strscan/pull/164)
https://github.com/ruby/strscan/commit/29ad49f89d
2025-10-14 00:42:32 +00:00
Burdette Lamar 94ddf47624 [ruby/strscan] [DOC] Fix link
(https://github.com/ruby/strscan/pull/162)

https://github.com/ruby/strscan/commit/a9340ab377
2025-09-03 23:38:37 +09:00
Yudai Takada b7690c58b9 [ruby/strscan] [DOC] Fix typo in documentation
(https://github.com/ruby/strscan/pull/129)

s/begining/beginning/

https://github.com/ruby/strscan/commit/734b823463
2024-12-26 10:27:24 +09:00
Alexander Momchilov 41e24c2f3e [ruby/strscan] [DOC] Add syntax highlighting to MarkDown code blocks
(https://github.com/ruby/strscan/pull/126)

Split off from https://github.com/ruby/ruby/pull/12322

https://github.com/ruby/strscan/commit/9bee37e0f5
2024-12-16 10:10:34 +09:00
NAITOH Jun cb8f186205 [ruby/strscan] [DOC] doc/strscan/strscan.md - update Matcher Methods
(https://github.com/ruby/strscan/pull/123)

Added support for string pattern type in
https://github.com/ruby/strscan/pull/106.
And fix Success Return content.

https://github.com/ruby/strscan/commit/6a5acde674
2024-12-10 11:30:19 +09:00
MSP-Greg cd4b45ab17 [ruby/strscan] [DOC] doc/strscan/strscan.md - fix triple backtick
(https://github.com/ruby/strscan/pull/112)

See current doc, search for '## Target Substring', notice the backtick
that isn't visible to the GitHub md parser.

https://github.com/ruby/strscan/blob/843e931d134b0a8f0284296250454374e3f8a6aa/doc/strscan/strscan.md

Fixed in the PR, see:

https://github.com/MSP-Greg/strscan/blob/00-strscan.md/doc/strscan/strscan.md

https://github.com/ruby/strscan/commit/041b15df4c
2024-10-29 13:52:22 +09:00
Hiroshi SHIBATA 8080cb7090 Removed trailing spaces. 2024-06-04 15:00:47 +09:00
Hiroshi SHIBATA 3eda59e975 Sync strscan HEAD again.
https://github.com/ruby/strscan/pull/99 split document with multi-byte
chars.
2024-06-04 12:40:08 +09:00
Hiroshi SHIBATA 78bfde5d9f Revert "[ruby/strscan] Doc for StringScanner"
This reverts commit 974ed1408c.
2024-05-30 21:13:10 +09:00
Hiroshi SHIBATA d70b0da482 Revert "Fix reference path for strscan documentation"
This reverts commit 1fa93fb948.
2024-05-30 21:13:01 +09:00
Hiroshi SHIBATA 1fa93fb948 Fix reference path for strscan documentation 2024-05-30 14:29:25 +09:00
Burdette LamarandSutou Kouhei 974ed1408c [ruby/strscan] Doc for StringScanner
(https://github.com/ruby/strscan/pull/96)

#peek_byte and #scan_byte not updated (not available in my repo --
sorry).

---------

https://github.com/ruby/strscan/commit/0123da7352

Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
2024-05-30 12:34:18 +09:00