Finally ready for v.1.0.0 release. Docs updated.

connorferster · Sep 19, 2020 · c811fa5 · c811fa5
1 parent fc5f773
commit c811fa5
Show file tree

Hide file tree

Showing 33 changed files with 584 additions and 297 deletions.
diff --git a/eqn_lib.py → Examples/eqn_lib.py b/eqn_lib.py → Examples/eqn_lib.py
diff --git a/ladder_problem-Copy1.png → Examples/ladder_problem-Copy1.png b/ladder_problem-Copy1.png → Examples/ladder_problem-Copy1.png
diff --git a/README.md b/README.md
diff --git a/docs/images/Screenshot 2020-09-18 222151.png b/docs/images/Screenshot 2020-09-18 222151.png
diff --git a/docs/images/basic_demo1.gif b/docs/images/basic_demo1.gif
diff --git a/docs/images/comments.png b/docs/images/comments.png
diff --git a/docs/images/conditionals.png b/docs/images/conditionals.png
diff --git a/docs/images/decorator.gif b/docs/images/decorator.gif
diff --git a/docs/images/decorator.png b/docs/images/decorator.png
diff --git a/docs/images/display_var.png b/docs/images/display_var.png
diff --git a/docs/images/forallpeople.png b/docs/images/forallpeople.png
diff --git a/docs/images/greek.png b/docs/images/greek.png
diff --git a/docs/images/greeks.png b/docs/images/greeks.png
diff --git a/docs/images/integration.png b/docs/images/integration.png
diff --git a/docs/images/no_subs.png b/docs/images/no_subs.png
diff --git a/docs/images/prime.png b/docs/images/prime.png
diff --git a/docs/images/quadratic_formula_basic.png b/docs/images/quadratic_formula_basic.png
diff --git a/docs/images/quadratic_formula_long.png b/docs/images/quadratic_formula_long.png
diff --git a/docs/images/quadratic_formula_params.png b/docs/images/quadratic_formula_params.png
diff --git a/docs/images/quadratic_formula_precision.png b/docs/images/quadratic_formula_precision.png
diff --git a/docs/images/quadratic_formula_short.png b/docs/images/quadratic_formula_short.png
diff --git a/docs/images/quadratic_formula_symbolic.png b/docs/images/quadratic_formula_symbolic.png
diff --git a/docs/images/subscripts.png b/docs/images/subscripts.png
diff --git a/docs/images/sympy.png b/docs/images/sympy.png
diff --git a/docs/images/tex.png b/docs/images/tex.png
diff --git a/handcalcs/__init__.py b/handcalcs/__init__.py
@@ -12,7 +12,7 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-__version__ = "0.8.1" #
+__version__ = "1.0.0" #
 from handcalcs.decorator import handcalc
 from handcalcs.install_templates import install_html, install_latex
 __all__ = ["handcalc"]

diff --git a/handcalcs/decorator.py b/handcalcs/decorator.py
@@ -5,14 +5,17 @@
 import innerscope
 from handcalcs.handcalcs import LatexRenderer
 
-def handcalc(override: str = "", left: str = "", right: str = "", jupyter_display: bool = False):
+
+def handcalc(
+    override: str = "", precision: int = 3, left: str = "", right: str = "", jupyter_display: bool = False
+):
     # @wraps(func)
     def handcalc_decorator(func):
         # use innerscope to get the values of locals within the function
         scoped_func = innerscope.scoped_function(func)
 
         def wrapper(*args, **kwargs):
-            line_args = {"override": "", "precision": 3}
+            line_args = {"override": override, "precision": precision}
             func_source = inspect.getsource(func)
             cell_source = _func_source_to_cell(func_source)
             scope = scoped_func(*args, **kwargs)
@@ -23,12 +26,16 @@ def wrapper(*args, **kwargs):
                 try:
                     from IPython.display import Latex, display
                 except ModuleNotFoundError:
-                    ModuleNotFoundError("jupyter_display option requires IPython.display to be installed.")
+                    ModuleNotFoundError(
+                        "jupyter_display option requires IPython.display to be installed."
+                    )
                 display(Latex(latex_code))
                 return calculated_results
             latex_code = latex_code.replace("\\[", "").replace("\\]", "")
             return (left + latex_code + right, calculated_results)
+
         return wrapper
+
     return handcalc_decorator