From 6ee5af0a16a5f1a32eb933e30d8b86ff4e691beb Mon Sep 17 00:00:00 2001
From: Bruce Hill <bruce@bruce-hill.com>
Date: Mon, 21 Apr 2025 14:45:39 -0400
Subject: Add short descriptions for API methods to improve manpages

---
 api/bytes.yaml | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'api/bytes.yaml')

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:
-- 
cgit v1.2.3