aboutsummaryrefslogtreecommitdiff
path: root/doc/language/function
diff options
context:
space:
mode:
Diffstat (limited to 'doc/language/function')
-rw-r--r--doc/language/function/cpsc-function-asc.7.md4
-rw-r--r--doc/language/function/cpsc-function-chr.7.md5
-rw-r--r--doc/language/function/cpsc-function-eof.7.md5
-rw-r--r--doc/language/function/cpsc-function-is_num.7.md5
-rw-r--r--doc/language/function/cpsc-function-lcase.7.md5
-rw-r--r--doc/language/function/cpsc-function-left.7.md4
-rw-r--r--doc/language/function/cpsc-function-length.7.md4
-rw-r--r--doc/language/function/cpsc-function-mid.7.md5
-rw-r--r--doc/language/function/cpsc-function-num_to_str.7.md4
-rw-r--r--doc/language/function/cpsc-function-right.7.md4
-rw-r--r--doc/language/function/cpsc-function-str_to_num.7.md5
-rw-r--r--doc/language/function/cpsc-function-ucase.7.md5
12 files changed, 12 insertions, 43 deletions
diff --git a/doc/language/function/cpsc-function-asc.7.md b/doc/language/function/cpsc-function-asc.7.md
index 72403a7..17ba8fe 100644
--- a/doc/language/function/cpsc-function-asc.7.md
+++ b/doc/language/function/cpsc-function-asc.7.md
@@ -13,8 +13,7 @@ ASC(text : STRING) RETURNS INTEGER
# DESCRIPTION
-Return the unsigned byte code of the character, or of the first byte of a
-string. Use a nonempty string; for ASCII characters this is the ASCII code.
+Return the unsigned byte code of the character, or of the first byte of a string. Use a nonempty string; for ASCII characters this is the ASCII code.
# EXAMPLE
@@ -25,4 +24,3 @@ OUTPUT ASC('A')
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-chr(7)](cpsc-function-chr.7.md).
-
diff --git a/doc/language/function/cpsc-function-chr.7.md b/doc/language/function/cpsc-function-chr.7.md
index 59b3121..1eab413 100644
--- a/doc/language/function/cpsc-function-chr.7.md
+++ b/doc/language/function/cpsc-function-chr.7.md
@@ -12,9 +12,7 @@ CHR(code : INTEGER) RETURNS STRING
# DESCRIPTION
-Convert the low eight bits of code to a one-byte string.
-The result is STRING, not CHAR. Use ASCII codes 1 to 127 for
-ordinary text; code 0 produces an empty string.
+Convert the low eight bits of code to a one-byte string. The result is STRING, not CHAR. Use ASCII codes 1 to 127 for ordinary text; code 0 produces an empty string.
# EXAMPLE
@@ -25,4 +23,3 @@ OUTPUT CHR(65)
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-asc(7)](cpsc-function-asc.7.md).
-
diff --git a/doc/language/function/cpsc-function-eof.7.md b/doc/language/function/cpsc-function-eof.7.md
index 3ab2d31..397c713 100644
--- a/doc/language/function/cpsc-function-eof.7.md
+++ b/doc/language/function/cpsc-function-eof.7.md
@@ -12,9 +12,7 @@ EOF(filename : STRING) RETURNS BOOLEAN
# DESCRIPTION
-Return true when no further characters remain in a file opened FOR READ.
-The test does not consume the next character. Testing an unopened file or
-a file in the wrong mode terminates execution.
+Return true when no further characters remain in a file opened FOR READ. The test does not consume the next character. Testing an unopened file or a file in the wrong mode terminates execution.
# EXAMPLE
@@ -31,4 +29,3 @@ CLOSEFILE "notes.txt"
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-keyword-openfile(7)](../keyword/cpsc-keyword-openfile.7.md), [cpsc-keyword-readfile(7)](../keyword/cpsc-keyword-readfile.7.md), [cpsc-keyword-closefile(7)](../keyword/cpsc-keyword-closefile.7.md).
-
diff --git a/doc/language/function/cpsc-function-is_num.7.md b/doc/language/function/cpsc-function-is_num.7.md
index a85acfe..a1fe34e 100644
--- a/doc/language/function/cpsc-function-is_num.7.md
+++ b/doc/language/function/cpsc-function-is_num.7.md
@@ -12,9 +12,7 @@ IS_NUM(text : STRING) RETURNS BOOLEAN
# DESCRIPTION
-Return true for a nonempty string fully consumed by the runtime's
-numeric conversion. Leading whitespace is accepted; trailing whitespace
-or other trailing text is rejected.
+Return true for a nonempty string fully consumed by the runtime's numeric conversion. Leading whitespace is accepted; trailing whitespace or other trailing text is rejected.
# EXAMPLE
@@ -25,4 +23,3 @@ OUTPUT IS_NUM("12.5")
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-str_to_num(7)](cpsc-function-str_to_num.7.md).
-
diff --git a/doc/language/function/cpsc-function-lcase.7.md b/doc/language/function/cpsc-function-lcase.7.md
index c8c7db9..a2cbf44 100644
--- a/doc/language/function/cpsc-function-lcase.7.md
+++ b/doc/language/function/cpsc-function-lcase.7.md
@@ -12,9 +12,7 @@ LCASE(text : STRING) RETURNS STRING
# DESCRIPTION
-Return a copy with letters converted to lower case. Unlike guide section 5.5's
-CHAR-to-CHAR signature, cpsc accepts text and returns STRING. Use ASCII
-text for predictable character conversion.
+Return a copy with letters converted to lower case. Unlike guide section 5.5's CHAR-to-CHAR signature, cpsc accepts text and returns STRING. Use ASCII text for predictable character conversion.
# EXAMPLE
@@ -25,4 +23,3 @@ OUTPUT LCASE("HELLO")
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-ucase(7)](cpsc-function-ucase.7.md).
-
diff --git a/doc/language/function/cpsc-function-left.7.md b/doc/language/function/cpsc-function-left.7.md
index 38a703e..8f27e24 100644
--- a/doc/language/function/cpsc-function-left.7.md
+++ b/doc/language/function/cpsc-function-left.7.md
@@ -12,8 +12,7 @@ LEFT(text : STRING, count : INTEGER) RETURNS STRING
# DESCRIPTION
-Return up to count bytes from the beginning. Counts larger than the string
-length return the whole string; negative counts return an empty string.
+Return up to count bytes from the beginning. Counts larger than the string length return the whole string; negative counts return an empty string.
# EXAMPLE
@@ -24,4 +23,3 @@ OUTPUT LEFT("Hello", 2)
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-right(7)](cpsc-function-right.7.md), [cpsc-function-mid(7)](cpsc-function-mid.7.md).
-
diff --git a/doc/language/function/cpsc-function-length.7.md b/doc/language/function/cpsc-function-length.7.md
index 9730798..fcdc47a 100644
--- a/doc/language/function/cpsc-function-length.7.md
+++ b/doc/language/function/cpsc-function-length.7.md
@@ -12,8 +12,7 @@ LENGTH(text : STRING) RETURNS INTEGER
# DESCRIPTION
-Return the number of bytes before the string terminator. String operations
-are byte-based, so this is not a Unicode character count.
+Return the number of bytes before the string terminator. String operations are byte-based, so this is not a Unicode character count.
# EXAMPLE
@@ -24,4 +23,3 @@ OUTPUT LENGTH("Hello")
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-mid(7)](cpsc-function-mid.7.md), [cpsc-function-left(7)](cpsc-function-left.7.md), [cpsc-function-right(7)](cpsc-function-right.7.md).
-
diff --git a/doc/language/function/cpsc-function-mid.7.md b/doc/language/function/cpsc-function-mid.7.md
index 66f7294..0956b43 100644
--- a/doc/language/function/cpsc-function-mid.7.md
+++ b/doc/language/function/cpsc-function-mid.7.md
@@ -12,9 +12,7 @@ MID(text : STRING, start : INTEGER, count : INTEGER) RETURNS STRING
# DESCRIPTION
-Return up to count bytes starting at the one-based position start.
-Positions below 1 clamp to 1; positions beyond the end return an empty string.
-The count clamps to the available bytes; negative counts return an empty string.
+Return up to count bytes starting at the one-based position start. Positions below 1 clamp to 1; positions beyond the end return an empty string. The count clamps to the available bytes; negative counts return an empty string.
# EXAMPLE
@@ -25,4 +23,3 @@ OUTPUT MID("ABCDEFGH", 2, 3)
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-left(7)](cpsc-function-left.7.md), [cpsc-function-right(7)](cpsc-function-right.7.md), [cpsc-function-length(7)](cpsc-function-length.7.md).
-
diff --git a/doc/language/function/cpsc-function-num_to_str.7.md b/doc/language/function/cpsc-function-num_to_str.7.md
index fb4f6fc..fb8e6fd 100644
--- a/doc/language/function/cpsc-function-num_to_str.7.md
+++ b/doc/language/function/cpsc-function-num_to_str.7.md
@@ -12,8 +12,7 @@ NUM_TO_STR(number : INTEGER or REAL) RETURNS STRING
# DESCRIPTION
-Format INTEGER as signed decimal text and REAL with six digits after the
-decimal point.
+Format INTEGER as signed decimal text and REAL with six digits after the decimal point.
# EXAMPLE
@@ -24,4 +23,3 @@ OUTPUT NUM_TO_STR(42), " ", NUM_TO_STR(3.5)
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-str_to_num(7)](cpsc-function-str_to_num.7.md).
-
diff --git a/doc/language/function/cpsc-function-right.7.md b/doc/language/function/cpsc-function-right.7.md
index 9aa10e6..2f70fbd 100644
--- a/doc/language/function/cpsc-function-right.7.md
+++ b/doc/language/function/cpsc-function-right.7.md
@@ -12,8 +12,7 @@ RIGHT(text : STRING, count : INTEGER) RETURNS STRING
# DESCRIPTION
-Return up to count bytes from the end. Use a nonnegative count.
-Counts larger than the string length return the whole string.
+Return up to count bytes from the end. Use a nonnegative count. Counts larger than the string length return the whole string.
# EXAMPLE
@@ -24,4 +23,3 @@ OUTPUT RIGHT("Hello", 2)
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-left(7)](cpsc-function-left.7.md), [cpsc-function-mid(7)](cpsc-function-mid.7.md).
-
diff --git a/doc/language/function/cpsc-function-str_to_num.7.md b/doc/language/function/cpsc-function-str_to_num.7.md
index 341b757..b0ceef2 100644
--- a/doc/language/function/cpsc-function-str_to_num.7.md
+++ b/doc/language/function/cpsc-function-str_to_num.7.md
@@ -12,9 +12,7 @@ STR_TO_NUM(text : STRING) RETURNS REAL
# DESCRIPTION
-Return REAL, including for integer-looking text. Conversion can stop at
-trailing text; invalid text returns zero. Use IS_NUM first when the whole
-string must be a valid number.
+Return REAL, including for integer-looking text. Conversion can stop at trailing text; invalid text returns zero. Use IS_NUM first when the whole string must be a valid number.
# EXAMPLE
@@ -25,4 +23,3 @@ OUTPUT STR_TO_NUM("12.5")
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-is_num(7)](cpsc-function-is_num.7.md), [cpsc-function-num_to_str(7)](cpsc-function-num_to_str.7.md).
-
diff --git a/doc/language/function/cpsc-function-ucase.7.md b/doc/language/function/cpsc-function-ucase.7.md
index 6356f48..728ae14 100644
--- a/doc/language/function/cpsc-function-ucase.7.md
+++ b/doc/language/function/cpsc-function-ucase.7.md
@@ -12,9 +12,7 @@ UCASE(text : STRING) RETURNS STRING
# DESCRIPTION
-Return a copy with letters converted to upper case. Unlike guide section 5.5's
-CHAR-to-CHAR signature, cpsc accepts text and returns STRING. Use ASCII
-text for predictable character conversion.
+Return a copy with letters converted to upper case. Unlike guide section 5.5's CHAR-to-CHAR signature, cpsc accepts text and returns STRING. Use ASCII text for predictable character conversion.
# EXAMPLE
@@ -25,4 +23,3 @@ OUTPUT UCASE("Hello")
# SEE ALSO
[cpsc-language-overview(7)](../cpsc-language-overview.7.md), [cpsc-function-lcase(7)](cpsc-function-lcase.7.md).
-