aryal/coreutils
1
0
Fork 0
forked from bonsai/harakit
Code Pull Requests Activity

docs: remove unnecessary references to the name of each program

Browse Source
This commit is contained in:
Emma Tebibyte
2024-03-26 19:22:30 -06:00
parent cf76fa94e6
commit 63a0c683f9
11 changed files with 129 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/rpn.1
View File

@@ -17,10 +17,13 @@ rpn
.SH DESCRIPTION
Rpn evaluates reverse polish notation expressions either read from the standard
input or parsed from provided arguments. See the STANDARD INPUT section.
Evaluate reverse polish notation.
Upon evaluation, rpn will print the resulting number on the stack to the
The program evaluates reverse polish notation expressions either read from the
standard input or parsed from provided arguments. See the STANDARD INPUT
section.
Upon evaluation, the program will print the resulting number on the stack to the
standard output. Any further specified numbers will be placed at the end of the
stack.
@@ -28,14 +31,16 @@ For information on for reverse polish notation syntax, see rpn(7).
.SH STANDARD INPUT
If arguments are passed to rpn, it interprets them as an expression to be
evaluated. Otherwise, it reads whitespace-delimited numbers and operations from
the standard input.
If arguments are passed , they are interpreted as an expression to be evaluated.
Otherwise, it reads whitespace-delimited numbers and operations from the
standard input.
.SH DIAGNOSTICS
If encountering a syntax error, rpn will exit with the appropriate error code
as defined by sysexits.h(3) and print an error message.
In the event of a syntax error, the program will print an
In the event of an error, a debug message will be printed and the program will
exit with the appropriate sysexits.h(3) error code.
.SH CAVEATS
@@ -44,7 +49,7 @@ with the IEEE Standard for Floating Point Arithmetic (IEEE 754), floating-point
arithmetic has rounding errors. This is somewhat curbed by using the
machine epsilon as provided by the Rust standard library to which to round
numbers. Because of this, variation is expected in the number of decimal places
rpn can handle based on the platform and hardware of any given machine.
the program can handle based on the platform and hardware of any given machine.
.SH RATIONALE