From 1b299f8ee1f3cbf367327bd3eedbe600f7c32b57 Mon Sep 17 00:00:00 2001 From: emma Date: Mon, 17 Jun 2024 23:16:25 -0600 Subject: [PATCH] rpn.1: fixes clunkiness --- docs/rpn.1 | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/rpn.1 b/docs/rpn.1 index 507789d..01e00b9 100644 --- a/docs/rpn.1 +++ b/docs/rpn.1 @@ -4,7 +4,7 @@ .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license, .\" visit . .\" -.TH RPN 1 2024-06-06 "Bonsai Core Utilites 0.13.8" +.TH RPN 1 2024-06-17 "Bonsai Core Utilites 0.13.8" .SH NAME rpn \(en reverse polish notation evaluation .\" @@ -18,12 +18,12 @@ rpn Evaluate reverse polish notation. -The program evaluates reverse polish notation expressions either read from the +The program evaluates reverse polish notation expressions read either 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 +Upon evaluation, the resulting number on the stack will be printed to the +standard output. Any further numbers specified will be placed at the end of the stack. For information on for reverse polish notation syntax, see @@ -31,8 +31,8 @@ For information on for reverse polish notation syntax, see .\" .SH STANDARD INPUT -If arguments are passed, they are interpreted as an expression to be -evaluated. Otherwise, it reads whitespace-delimited numbers and operations from +If arguments are specified, they are interpreted as an expression to be +evaluated. Otherwise, whitespace-delimited numbers and operations are read from the standard input. .\" .SH DIAGNOSTICS @@ -46,11 +46,13 @@ error message and continue accepting input. .SH CAVEATS Due to precision constraints and the way floats are represented in accordance -with the IEEE Standard for Floating Point Arithmetic (\fIIEEE 754\fP), -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 -the program can handle based on the platform and hardware of any given machine. +with the +.I IEEE Standard for Floating Point Arithmetic +(\fIIEEE 754\fP), floating-point arithmetic has rounding errors. This is +somewhat curbed by using the machine epsilon as provided by the Rust standard +library to which numbers are rounded. Because of this, variation is expected in +the number of decimal places the program can handle based on the platform and +hardware of any given machine. .\" .SH RATIONALE @@ -63,8 +65,8 @@ program. A pre-dates the standardized .BR bc (1p), the latter originally being a preprocessor for the former, and was included in -UNIX v2 onward. While it implements reverse polish notation, it still suffers -from being unable to accept an expression as an argument. +Second Edition UNIX and onward. While it implements reverse polish notation, it +still suffers from being unable to accept an expression as an argument. .\" .SH AUTHOR