diff options
| author | Bruce Hill <bruce@bruce-hill.com> | 2025-04-21 14:45:39 -0400 |
|---|---|---|
| committer | Bruce Hill <bruce@bruce-hill.com> | 2025-04-21 14:45:39 -0400 |
| commit | 6ee5af0a16a5f1a32eb933e30d8b86ff4e691beb (patch) | |
| tree | a4ccc48bef576be1cfd4d30342eebc684474e8f5 /api/bytes.yaml | |
| parent | 868ca31562dcc5d484d8f015adfa173c0a43c415 (diff) | |
Add short descriptions for API methods to improve manpages
Diffstat (limited to 'api/bytes.yaml')
| -rw-r--r-- | api/bytes.yaml | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/api/bytes.yaml b/api/bytes.yaml index 01f27fc3..52f48528 100644 --- a/api/bytes.yaml +++ b/api/bytes.yaml @@ -1,4 +1,5 @@ Byte.hex: + short: convert to hexidecimal description: > Convert a byte to a hexidecimal text representation. return: @@ -25,6 +26,7 @@ Byte.hex: = "0x12" Byte.is_between: + short: test if inside a range description: > Determines if an integer is between two numbers (inclusive). return: @@ -53,6 +55,7 @@ Byte.is_between: = yes Byte.parse: + short: convert text to a byte description: > Parse a byte literal from text. return: @@ -71,6 +74,7 @@ Byte.parse: = none Byte.to: + short: iterate over a range of bytes description: > Returns an iterator function that iterates over the range of bytes specified. return: |