update docs for release v1.0.1

gutow · May 23, 2024 · 2bf00d4 · 2bf00d4
1 parent d75b68c
commit 2bf00d4
Show file tree

Hide file tree

Showing 9 changed files with 6,922 additions and 16,510 deletions.
diff --git a/Demonstration of equation class.ipynb b/Demonstration of equation class.ipynb
diff --git a/ReadMe.md b/ReadMe.md
@@ -154,7 +154,7 @@ github](https://github.com/gutow/Algebra_with_Sympy/issues).
 
 ## Change Log
 
-* 1.0.1.dev2 ()
+* 1.0.1 (May 22, 2024)
   * BUG FIX: equation labels that include underscore characters "_" are now 
     accepted.
   * BUG FIX: wrapping equations formatted as LaTex equation (ie. surrounded 

diff --git a/algebra_with_sympy/algebraic_equation.py b/algebra_with_sympy/algebraic_equation.py
@@ -518,10 +518,14 @@ def unset_integers_as_exact():
 
 def units(names):
     """
-    This operation declares the symbols to be positive values, so that sympy will handle them properly
-    when simplifying expressions containing units.
+    This operation declares the symbols to be positive values, so that sympy
+    will handle them properly when simplifying expressions containing units.
+    Units defined this way are just unit symbols. If you want units that are
+    aware of conversions see sympy.physics.units.
 
-    :param string names: a string containing a space separated list of symbols to be treated as units.
+
+    :param string names: a string containing a space separated list of
+    symbols to be treated as units.
 
     :return string list of defined units: calls `name = symbols(name,
     positive=True)` in the interactive namespace for each symbol name.