Merge pull request #12 from TheItsProjects/stringmath-documentation

added documentation for check_valid_expression
TheItsProjects · Feb 26, 2023 · 67e1250 · 67e1250
2 parents 5ad6c2d + ac39391
commit 67e1250
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,8 @@ It uses the Shunting-Yard algorithm and follows the correct order of operation r
 
 If you provide an empty string as the input, a `ValueError` will be raised.
 
+The function `StringMath.check_valid_expression()` can be used to check whether a string is valid and can be processed. If the string is valid, the function will return `True`.
+
 ### WordMath
 
 ```py