Fix typos

Author: Blake-Madden

Examples.md

@@ -5,7 +5,7 @@ The following are examples demonstrating how to use TinyExpr++.
 ## Example 1
 
 ```cpp
-include "tinyexpr.h"
+#include "tinyexpr.h"
 #include <iostream>
 
 int main(int argc, char *argv[])
@@ -209,5 +209,5 @@ auto result = tep.evaluate("SUM(CELL 0, CELL 1, CELL 2, CELL 3, CELL 4)");
 
 // call the other function, getting the object's max value
 // (will be 8)
-res = tep.evaluate("CellMax()");
+result = tep.evaluate("CellMax()");
 ```

README.md

@@ -62,7 +62,7 @@ Please refer [here](TinyExprChanges.md) for a list of changes from the original
 
 ## Building
 
-*TinyExpr++* is self-contained in two files: "tinyexpr.cpp and "tinyexpr.h". To use
+*TinyExpr++* is self-contained in two files: "tinyexpr.cpp" and "tinyexpr.h". To use
 *TinyExpr++*, simply add those two files to your project.
 
 The documentation can be built using the following:
@@ -332,7 +332,7 @@ auto result = tep.evaluate("SUM(CELL 0, CELL 1, CELL 2, CELL 3, CELL 4)");
 
 // call the other function, getting the object's max value
 // (will be 8)
-res = tep.evaluate("CellMax()");
+result = tep.evaluate("CellMax()");
 ```
 
 ## Non-US Formatted Formulas
@@ -367,11 +367,10 @@ int main(int argc, char *argv[])
     tep.set_list_separator(';');
 
     /* This will compile the expression and check for errors. */
-    auto r = tep.evaluate(expression);
+    const auto r = tep.evaluate(expression);
 
     if (tep.success())
         {
-        const double r = tep.evaluate(expression);
         std::cout << "Result:\n\t" << r << "\n";
         }
     else

TinyExprChanges.md

@@ -1,6 +1,6 @@
 The following are changes from the original TinyExpr C library:
 
-- Compiles as C++17 code.
+- Compiles as C++20 code.
 - `te_*` functions are now wrapped in a `te_parser` class.
 - `te_interp()`, `te_compile()`, and `te_eval()` have been replaced with `te_parser::compile()`, `te_parser::evaluate()`, and `te_parser::set_variables_and_functions()`.
   `set_variables_and_functions()` sets your list of custom functions and variables. `compile()` compiles and optimizes an expression.
@@ -10,7 +10,7 @@ The following are changes from the original TinyExpr C library:
   The available flags for variables and functions are now just combinations of `TE_DEFAULT`, `TE_PURE`, and `TE_VARIADIC`.
 - Formula parsing is now case insensitive.
 - Added support for variadic functions (can accept 1-24 arguments); enabled through the `TE_VARIADIC` flag.
-  (Refer to the `AVERAGE()` function in `tinyexp.cpp` for an example.)
+  (Refer to the `AVERAGE()` function in `tinyexpr.cpp` for an example.)
 - Added support for parsing formulas in non-US format (e.g., `pow(2,2; 2)` instead of `pow(2.2, 2)`). Useful for when the program's locale is non-English.
   (Refer to [Example 4](Examples.md) for a demonstration.)
 - `te_expr` is now a derivable base class. This means that you can derive from `te_expr`, add new fields to that derived class (e.g., arrays, strings, even other classes)

docs/manual/compile-time-options.qmd

@@ -15,7 +15,7 @@ This flag will also disable all bitwise functions and operators.
 
 Compile with `TE_LONG_DOUBLE` defined to use `long double` as the default data type.
 
-Depending on the compiler, this may provide sufficient mantissa precision to represent ``uint64_t`` values exactly.
+Depending on the compiler, this may provide sufficient mantissa precision to represent `uint64_t` values exactly.
 Call `te_parser::supports_64bit()` (or `SUPPORTS64BIT()` in an expression at runtime) to confirm this.
 
 ## `TE_RAND_SEED` {-}

docs/manual/embedded-programming.qmd

@@ -69,7 +69,7 @@ void OnInterrupt()
     const_cast<te_parser&>(vTep).set_variables_and_functions(
          { {"STRESS_L", 10.1},
            {"P_LEVEL", .5} });
-    const_cast<te_parser&>(vTep).compile(("STRESS_L*P_LEVEL"));
+    const_cast<te_parser&>(vTep).compile("STRESS_L*P_LEVEL");
 
     if (vTep.success())
         {

docs/manual/technical-overview.qmd

@@ -56,12 +56,12 @@ DiagrammeR::grViz("digraph {
 
     <list>      =    <expr> {(",", ";" [dependent on locale]) <expr>}
     <expr>      =    <term> {("&" | "|") <term>}
-    <expr>      =    <term> {("<>" | "!=" | "=" | "<") | "<=" | ">" | ">=") <term>}
+    <expr>      =    <term> {("<>" | "!=" | "=" | "<" | "<=" | ">" | ">=") <term>}
     <expr>      =    <term> {("<<" | ">>") <term>}
     <expr>      =    <term> {("+" | "-") <term>}
     <term>      =    <factor> {("*" | "/" | "%") <factor>}
     <factor>    =    <power> {("^" | "**") <power>}
-    <power>     =    {("-" | "+")} <base>
+    <power>     =    {("-" | "+" | "~")} <base>
     <base>      =    <constant>
                    | <variable>
                    | <function-0> {"(" ")"}

docs/manual/unknown-symbol-resolution.qmd

@@ -91,7 +91,7 @@ te_parser tep;
 // Create a handler for undefined tokens that will recognize
 // dynamic strings like "FY2004" or "FY1997" and convert them to 2004 and 1997.
 tep.set_unknown_symbol_resolver(
-    // Handler should except a string (which will be the unrecognized token)
+    // Handler should accept a string (which will be the unrecognized token)
     // and return a te_type.
     [](std::string_view str) -> te_type
     {

tinyexpr.h

@@ -288,7 +288,7 @@ class te_string_less
 
 /// @brief A compiled expression.
 /// @details Can also be an additional object that can be passed to
-///     te_confun0-te_confun7 functions via a te_variable.
+///     te_confun0-te_confun24 functions via a te_variable.
 class te_expr
     {
   public:
@@ -338,7 +338,7 @@ class te_variable
     te_variant_type m_value;
     /// @brief The type that m_value represents.
     te_variable_flags m_type{ TE_DEFAULT };
-    /// If @c m_value is a function pointer of type `te_confun0`-`te_confun7`, then
+    /// If @c m_value is a function pointer of type `te_confun0`-`te_confun24`, then
     /// this is passed to that function when called. This is useful for passing
     /// an object which manages additional data to your functions.
     te_expr* m_context{ nullptr };