Spellcheck Project

Add `cargo spellcheck` Fix all the spelling issues. Signed-off-by: Nathaniel Clark <Nathaniel.Clark@misrule.us>
utopiabound · May 16, 2024 · 20f9b01 · 20f9b01
1 parent 6a65f7f
commit 20f9b01
Show file tree

Hide file tree

Showing 8 changed files with 441 additions and 423 deletions.
diff --git a/.config/rpn.dic b/.config/rpn.dic
@@ -0,0 +1,4 @@
+1
+HP48G
+iff
+RPN
diff --git a/.config/spellcheck.toml b/.config/spellcheck.toml
@@ -0,0 +1,4 @@
+[hunspell]
+extra_dictionaries = ["rpn.dic"]
+lang = "en_US"
+search_dirs = ["."]
diff --git a/Makefile b/Makefile
@@ -30,5 +30,7 @@ clean:
 	rm -rf rpn-rs.app/
 
 test:
-	cargo clippy --all
-	cargo test
+	cargo fmt --check
+	cargo clippy --locked --all
+	cargo test --locked
+	cargo spellcheck
diff --git a/README.md b/README.md
@@ -1,38 +1,38 @@
 # rpn-rs
 
-RPN-rs is an RPN calculator written in rust using FLTK.
+RPN-rs is an RPN calculator written in rust using `FLTK`.
 
-Also can be run as CLI or as a TUI.
+Also can be run as command line or as a graphical text user interface.
 
 ## Features
 
-* Number - Scaler (via [rug](latest/rug/struct.Integer.html) crate)
-   * Arbitrary precision rational numbers ([GMP](https://gmplib.org/))
-   * High-precision floating-point ([MPFR](https://www.mpfr.org/))
-   * Complex numbers ([MPC](https://www.multiprecision.org/mpc/))
-* Numbers - Matrix (via [libmat](https://github.com/wiebecommajonas/libmat))
-   * Matricies of any of above Scalers
-   * Correct interaction between Scalers and Matricies
-* UI
-   * GUI - Graphical User Interface
-   * TUI - Full terminal user interface
-   * CLI - Basic interacive CLI
+* Number - Scalar (via [`rug`](latest/rug/struct.Integer.html) crate)
+   * Arbitrary precision rational numbers ([`GMP`](https://gmplib.org/))
+   * High-precision floating-point ([`MPFR`](https://www.mpfr.org/))
+   * Complex numbers ([`MPC`](https://www.multiprecision.org/mpc/))
+* Numbers - Matrix (via [`libmat`](https://github.com/wiebecommajonas/libmat))
+   * Matrices of any of above scalars
+   * Correct interaction between scalars and Matrices
+* User-Interface
+   * `GUI` - Graphical User Interface
+   * `TUI` - Full terminal user interface
+   * `CLI` - Basic interactive command line
 
 ## Goals
 
 * RPN Calculator
 * Arbitrary precision
-* Matrixes
+* Matrices
 * Simple stack view
 
 ## Linux (Fedora) Build Requires
 
-* libstdc++-static
-* libpng-devel
-* libjpeg-devel
-* zlib-devel
+* `libstdc++-static`
+* `libpng-devel`
+* `libjpeg-devel`
+* `zlib-devel`
 
 ## Inspired by
 
-* [GRPN](https://github.com/utopiabound/grpn)
-* HP RPN Calculators (e.g. HP48G+)
+* [`GRPN`](https://github.com/utopiabound/grpn)
+* HP RPN Calculators (e.g. HP48G)
diff --git a/src/fixtures/help.html b/src/fixtures/help.html
@@ -2,11 +2,11 @@
 <!-- HTML 2.0 https://www.w3.org/MarkUp/1995-archive/html-spec.html + Tables -->
 <html>
   <head>
-    <title>RPN-rs Graphical Reverse Polish Notation Caluclator</title>
+    <title>RPN-rs Graphical Reverse Polish Notation Calculator</title>
   </head>
   <body>
     <h1>RPN-rs is a graphical reverse polish notation (RPN) calculator</h1>
-    <p>RPN-rs works with arbitrary presision rational numbers, large precision
+    <p>RPN-rs works with arbitrary precision rational numbers, large precision
       floating point numbers, complex numbers, and matrices (in progress).
       Numbers can be displayed in 4 different radix modes (base 2, 8, 10, 16).
       <!-- Complex numbers can be displayed in either Cartesian or polar
@@ -50,7 +50,7 @@ <h1>RPN-rs is a graphical reverse polish notation (RPN) calculator</h1>
       <tr><td>rollu(p) | ru(p) | roll</td><td>0</td><td colspan=2>Pop 1 item, and move it to end of stack</td></tr>
       <tr><td>rolld(own) | rd(own)</td><td>0</td><td colspan=2>Opposite of rollup</td></tr>
       <tr><td>swap | sw</td><td>0</td><td colspan=2>Swap first two items on stack</td></tr>
-      <tr><td>undo | u</td><td><i>N/A</i></td><td colspan=2>Undo last operation (otder tdan clear)</td></tr>
+      <tr><td>undo | u</td><td><i>N/A</i></td><td colspan=2>Undo last operation (other than clear)</td></tr>
       <tr><th colspan=4>Arithmetic Operations</th></tr>
       <tr><td colspan=4 align="center">results of operations are pushed to stack</td></tr>
       <tr><td>+</td><td>2</td><td>Add first two items</td><td><i>x+y</i></td></tr>
@@ -69,7 +69,7 @@ <h1>RPN-rs is a graphical reverse polish notation (RPN) calculator</h1>
       <tr><td>sqrt</td><td>1</td><td>Square root</td><td><i>./&macr;x</i></td></tr>
       <tr><td>trunc(ate)</td><td>1</td><td colspan=2>Truncate value to Integer</td></tr>
       <tr><td>round | rnd</td><td>1</td><td colspan=2>Round value to Integer (a half, rounds away from zero)</td></tr>
-      <tr><th colspan=4>Scaler Operations</th></tr>
+      <tr><th colspan=4>Scalar Operations</th></tr>
       <tr><td>factor</td><td>1</td><td colspan=2>Find all <a href="https://en.wikipedia.org/wiki/Prime_number">prime</a> factors of item</td></tr>
       <tr><td>ln</td><td>1</td><td><a href="https://en.wikipedia.org/wiki/Natural_logarithm">Natural logarithm</a></td><td><i>ln(x)</i></td></tr>
       <tr><td>log | log10</td><td>1</td><td><a href="https://en.wikipedia.org/wiki/Logarithm">Logarithm</a> (base 10)</td><td><i>log10(x)</i></td></tr>
@@ -92,6 +92,6 @@ <h1>RPN-rs is a graphical reverse polish notation (RPN) calculator</h1>
       <tr><td>J | ones</td><td>1</td><td>Matrix of Ones NxN</td><td><i>J</i></td></tr>
     </table>
 
-    <p>Command abreviations "ident(ity)" can be enter as either "ident" or "identity".</p>
+    <p>Command abbreviations "ident(ity)" can be enter as either "ident" or "identity".</p>
   </body>
 </html>
diff --git a/src/main.rs b/src/main.rs
@@ -21,7 +21,7 @@ use std::collections::VecDeque;
 /// RPN Calculator
 struct App {
     #[clap(short, long, default_value_t)]
-    /// Type of UI to display
+    /// Type of `UI` to display
     flavor: Flavor,
 }