Changeset 39856 in project

Timestamp:

04/05/21 23:35:37 (3 weeks ago)

Author:

Kon Lovett

Message:

remove string-utils dep & add utf8, better arg names

File:

• wiki/eggref/5/semantic-version (modified) (13 diffs)

wiki/eggref/5/semantic-version

@@ -8 +8 @@
 == Documentation
 
-Semantic-Version handling.
+A rather busy Semantic Versioning library.
 
 == Usage
@@ -18 +18 @@
 === version-punctuation
 
-<procedure>(version-punctuation [STR]) -> string</procedure>
+<parameter>(version-punctuation [STR]) -> string</parameter>
 
 Returns the string (set) of punctuation characters. The first is always the
 default.
 
-; STR : {{string}} ; default is "._- +;:,"
+; STR : {{string}} ; punctuation set, default is "._- +;:,"
 
 === version-tail-zero
 
-<procedure>(version-tail-zero [BOOL]) -> boolean</procedure>
+<parameter>(version-tail-zero [IGN?]) -> boolean</parameter>
 
 Returns whether trailing 0's are ignored during comparision.
 
+; IGN? : {{boolean}} ; ignore flag, default is {{#f}}.
+
 === make-version
+
+<procedure>(make-version ELM...) --> version</procedure>
+
+Returns a new version with the specified elements, ELM..., and the default
+punctuation (see {{version-punctuation}}).
+
+; ELM : {{(or number string symbol)}} ; version element.
+
+'''Note''' that the {{symbol}} printname is used internally.
+Returns whether trailing 0's are ignored during comparision.
+
 === check-version
 === error-version
 
-<procedure>(make-version ELM...) --> version</procedure>
 <procedure>(check-version LOC OBJ [NAM]) -> version</procedure>
 <procedure>(error-version LOC OBJ [NAM])</procedure>
 
-Returns a new version with the specified elements, ELM..., and the default
-punctuation (see {{version-punctuation}}).
-
-; ELM : {{(or number string symbol)}} ; version element.
-
-'''Note''' that the {{symbol}} printname is used internally.
-Returns whether trailing 0's are ignored during comparision.
+Similar to ''check-errors'' procedures.
 
 === version-copy
@@ -81 +87 @@
 <procedure>(version-puncs VER) --> list</procedure>
 
-Returns list of separator characters.
+Returns list of separator characters (punctuation).
 
 ; VER : {{version}} ; version to query.
@@ -147 +153 @@
 Returns a SRFI 128 {{comparator}} for the {{version}} type.
 
+; {{comparator-hash-function}} : {{version-hash}}
+; {{comparator-type-test-predicate}} : {{version?}}
+; {{comparator-equality-predicate comparator}} : {{version=?}}
+; {{comparator-ordering-predicate comparator}} : {{version<?}}
+
 === string->version
 
@@ -154 +165 @@
 preserved, and restored by {{version->string}}.
 
-; STR : {{string}} ; version string.
+; STR : {{string}} ; string to convert.
 
 === version->string
@@ -162 +173 @@
 Return the string form of the VER.
 
-; VER : {{version}} ; version to hash.
+; VER : {{version}} ; version to convert.
 
 === version-depth+!
 
-<procedure>(version-depth+! VER CNT PART [PUNC]) -> version</procedure>
-
-Returns VER with more "depth", as PART, interspersed with PUNC.
+<procedure>(version-depth+! VER CNT ELM [CHR]) -> version</procedure>
+
+Returns VER with more "depth", as ELM, interspersed with CHR.
 
 ; VER : {{version}} ; version to extend.
 ; CNT : {{integer}} ; element count.
-; PART : {{(or number string symbol)}} ; version element.
-; PUNC : {{char}} ; version punctuation, default is as above.
+; ELM : {{(or number string symbol)}} ; version element.
+; CHR : {{char}} ; version punctuation, default is as above.
 
 === version-depth-!
@@ -187 +198 @@
 === version-depth+
 
-<procedure>(version-depth+ VER CNT PART [PUNC]) --> version</procedure>
-
-Returns a copy of VER with more "depth", as PART, interspersed with PUNC.
+<procedure>(version-depth+ VER CNT ELM [CHR]) --> version</procedure>
+
+Returns a copy of VER with more "depth", as ELM, interspersed with CHR.
 
 ; VER : {{version}} ; version to extend.
 ; CNT : {{integer}} ; element count.
-; PART : {{(or number string symbol)}} ; version element.
-; PUNC : {{char}} ; version punctuation, default is as above.
+; ELM : {{(or number string symbol)}} ; version element.
+; CHR : {{char}} ; version punctuation, default is as above.
 
 === version-depth-
@@ -218 +229 @@
 === version-extend
 
-<procedure>(version-extend VER  COMP...) --> version</procedure>
+<procedure>(version-extend VER COMP...) --> version</procedure>
 
 Returns copy of VER with added "depth", in the form of a new "tail", in
@@ -228 +239 @@
 === version-inc!
 
-<procedure>(version-inc! VER [INDEX AMOUNT]) -> version</procedure>
-
-Return VER with INDEX element incremented by AMOUNT.
+<procedure>(version-inc! VER [IDX AMT]) -> version</procedure>
+
+Return VER with IDX element incremented by AMT.
 
 ; VER : {{version}} ; version to adjust.
-; INDEX : {{integer}} ; which element to adjust.
-; AMOUNT : {{number}} ; amount to adjust.
+; IDX : {{integer}} ; which element to adjust.
+; AMT : {{number}} ; amount to adjust.
 
 Currently only {{number}} elements may be targets.
@@ -240 +251 @@
 === version-dec!
 
-<procedure>(version-dec! VER [INDEX AMOUNT]) -> version</procedure>
-
-Return VER with INDEX element decremented by AMOUNT.
+<procedure>(version-dec! VER [IDX AMT]) -> version</procedure>
+
+Return VER with IDX element decremented by AMT.
 
 ; VER : {{version}} ; version to adjust.
-; INDEX : {{integer}} ; which element to adjust.
-; AMOUNT : {{number}} ; amount to adjust.
+; IDX : {{integer}} ; which element to adjust.
+; AMT : {{number}} ; amount to adjust.
 
 Currently only {{number}} elements may be targets.
@@ -252 +263 @@
 === version-inc
 
-<procedure>(version-inc VER [INDEX AMOUNT]) --> version</procedure>
-
-Return copy of VER with INDEX element incremented by AMOUNT.
+<procedure>(version-inc VER [IDX AMT]) --> version</procedure>
+
+Return copy of VER with IDX element incremented by AMT.
 
 ; VER : {{version}} ; version to adjust.
-; INDEX : {{integer}} ; which element to adjust.
-; AMOUNT : {{number}} ; amount to adjust.
+; IDX : {{integer}} ; which element to adjust.
+; AMT : {{number}} ; amount to adjust.
 
 Currently only {{number}} elements may be targets.
@@ -264 +275 @@
 === version-dec
 
-<procedure>(version-dec VER [INDEX AMOUNT]) --> version</procedure>
-
-Return copy of VER with INDEX element decremented by AMOUNT.
+<procedure>(version-dec VER [IDX AMT]) --> version</procedure>
+
+Return copy of VER with IDX element decremented by AMT.
 
 ; VER : {{version}} ; version to adjust.
-; INDEX : {{integer}} ; which element to adjust.
-; AMOUNT : {{number}} ; amount to adjust.
+; IDX : {{integer}} ; which element to adjust.
+; AMT : {{number}} ; amount to adjust.
 
 Currently only {{number}} elements may be targets.
@@ -311 +322 @@
 [[srfi-69]]
 [[srfi-128]]
-[[string-utils]]
+[[utf8]]
 
 [[test]]