mirror of https://github.com/mruby/mruby synced 2026-06-08 16:11:16 +00:00

Files

T

Yukihiro "Matz" Matsumoto 07b803e28a docs: replace xml-style markup with markdown in comments

Replace XML-style markup tags in comments with markdown equivalents:
- <code>...</code> to `...` (inline code)
- <tt>...</tt> to `...` (teletype/monospace)
- <i>...</i> to *...* (italics/emphasis)
- +...+ to `...` (parameter/variable references)

Updated 80+ files across core source, headers, mrbgems, and libraries
to use consistent markdown formatting in documentation comments.
Handled edge cases including special characters like <=> operators.

Co-authored-by: Atlassian Rovo Dev

2025-08-14 10:52:49 +09:00

mrblib

docs: replace xml-style markup with markdown in comments

2025-08-14 10:52:49 +09:00

test

mruby-compar-ext: add test for Comparable#clamp

2024-11-26 17:40:09 +09:00

mrbgem.rake

Fix summary typo for mrbgems/mruby-compar-ext

2021-12-25 20:46:25 +09:00

README.md

mruby-compar-ext: add README.md

2025-06-07 11:50:53 +09:00

README.md

mruby-compar-ext

Comparable module extension.

This mrbgem adds the clamp method to the Comparable module.

`Comparable#clamp`

The clamp method restricts a value to a given range.

Syntax:

obj.clamp(min, max) -> obj
obj.clamp(range)    -> obj

Description:

In the (min, max) form, it returns:
- min if obj <=> min is less than zero.
- max if obj <=> max is greater than zero.
- obj otherwise.
In the (range) form, it returns:
- range.begin if obj <=> range.begin is less than zero.
- range.end if obj <=> range.end is greater than zero (and range.end is not nil and the range is inclusive).
- obj otherwise.
If range.begin is nil, it is considered smaller than obj.
If range.end is nil, it is considered greater than obj.

Examples:

# Using min and max arguments
12.clamp(0, 100)         #=> 12
523.clamp(0, 100)        #=> 100
-3.123.clamp(0, 100)     #=> 0

'd'.clamp('a', 'f')      #=> 'd'
'z'.clamp('a', 'f')      #=> 'f'

# Using a Range argument
12.clamp(0..100)         #=> 12
523.clamp(0..100)        #=> 100
-3.123.clamp(0..100)     #=> 0

'd'.clamp('a'..'f')      #=> 'd'
'z'.clamp('a'..'f')      #=> 'f'

# Using ranges with nil begin or end
-20.clamp(0..)           #=> 0
523.clamp(..100)         #=> 100

Error Handling:

Raises an ArgumentError if an exclusive range (e.g., 0...100) is provided as the range argument when range.end is not nil.
Raises an ArgumentError if min and max arguments cannot be compared (e.g., a String and an Integer).
Raises an ArgumentError if the min argument is greater than the max argument.

100.clamp(0...100)       # ArgumentError: cannot clamp with an exclusive range
10.clamp("a", "z")       # ArgumentError: comparison of String with String failed (depending on mruby version, may also be other errors if types are incompatible)
100.clamp(10, 0)         # ArgumentError: min argument must be smaller than max argument