Documentation fixing, TODO fixing

Author: jepler

README.rst

@@ -35,21 +35,21 @@ Installing from PyPI
 .. note:: This library is not available on PyPI yet. Install documentation is included
    as a standard element. Stay tuned for PyPI availability!
 
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
+.. Remove the above note if PyPI version is/will be available at time of release.
    If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
-PyPI <https://pypi.org/project/adafruit-circuitpython-udecimal/>`_. To install for current user:
+PyPI <https://pypi.org/project/jepler-circuitpython-udecimal/>`_. To install for current user:
 
 .. code-block:: shell
 
-    pip3 install adafruit-circuitpython-udecimal
+    pip3 install jepler-circuitpython-udecimal
 
 To install system-wide (this may be required in some cases):
 
 .. code-block:: shell
 
-    sudo pip3 install adafruit-circuitpython-udecimal
+    sudo pip3 install jepler-circuitpython-udecimal
 
 To install in a virtual environment in your current project:
 
@@ -58,12 +58,19 @@ To install in a virtual environment in your current project:
     mkdir project-name && cd project-name
     python3 -m venv .env
     source .env/bin/activate
-    pip3 install adafruit-circuitpython-udecimal
+    pip3 install jepler-circuitpython-udecimal
 
 Usage Example
 =============
 
-.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
+.. code-block:: python
+
+    >>> from jepler_udecimal import Decimal
+    >>> Decimal(2)/3
+    Decimal('0.6666666666666666666666666667')
+    >>> Decimal('.1') + Decimal('.2') == Decimal('.3')
+    True
+
 
 Contributing
 ============

docs/examples.rst

@@ -9,11 +9,6 @@ Table of Contents
 
     self
 
-.. toctree::
-    :caption: Examples
-
-    examples
-
 .. toctree::
     :caption: API Reference
     :maxdepth: 3
@@ -23,19 +18,10 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
-.. toctree::
-    :caption: Related Products
-
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Other Links
 
-    Download <https://github.com/jepler/jepler_CircuitPython_udecimal/releases/latest>
+    Download <https://github.com/jepler/Jepler_CircuitPython_udecimal/releases/latest>
     CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
     CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
     Discord Chat <https://adafru.it/discord>

docs/index.rst

@@ -46,9 +46,9 @@
 issues associated with binary floating point.  The package is especially
 useful for financial applications or for contexts where users have
 expectations that are at odds with binary floating point (for instance,
-in binary floating point, `1.00 % 0.1` gives `0.09999999999999995` instead
-of `0.0`; `Decimal('1.00') % Decimal('0.1')` returns the expected
-`Decimal('0.00')`).
+in binary floating point, ``1.00 % 0.1`` gives ``0.09999999999999995`` instead
+of ``0.0``; ``Decimal('1.00') % Decimal('0.1')`` returns the expected
+``Decimal('0.00')``).
 
 Here are some examples of using the udecimal module:
 
@@ -475,6 +475,9 @@ def localcontext(ctx=None):
     Uses a copy of the current context if no context is specified
     The returned context manager creates a local decimal context
     in a with statement:
+
+    .. code-block:: python
+
         def sin(x):
              with localcontext() as ctx:
                  ctx.prec += 2
@@ -489,21 +492,24 @@ def sin(x):
                  # General Decimal Arithmetic Specification
              return +s  # Convert result to normal context
 
-    >>> setcontext(DefaultContext)
-    >>> print(getcontext().prec)
-    28
-    >>> with localcontext():
-    ...     ctx = getcontext()
-    ...     ctx.prec += 2
-    ...     print(ctx.prec)
-    ...
-    30
-    >>> with localcontext(ExtendedContext):
-    ...     print(getcontext().prec)
-    ...
-    9
-    >>> print(getcontext().prec)
-    28
+
+    .. code-block:: python
+
+        >>> setcontext(DefaultContext)
+        >>> print(getcontext().prec)
+        28
+        >>> with localcontext():
+        ...     ctx = getcontext()
+        ...     ctx.prec += 2
+        ...     print(ctx.prec)
+        ...
+        30
+        >>> with localcontext(ExtendedContext):
+        ...     print(getcontext().prec)
+        ...
+        9
+        >>> print(getcontext().prec)
+        28
     """
     if ctx is None:
         ctx = getcontext()
@@ -689,8 +695,9 @@ def from_float(cls, f):
         Note that Decimal.from_float(0.1) is not the same as Decimal('0.1').
         Since 0.1 is not exactly representable in binary floating point, the
         value is stored as the nearest representable value which is
-        0x1.999999999999ap-4.  The exact equivalent of the value in decimal
-        is 0.1000000000000000055511151231257827021181583404541015625.
+        0x1.999999999999ap-4.  The exact equivalent of the value in decimal is
+        0.1000000000000000055511151231257827021181583404541015625 on desktop
+        Python.  On CircuitPython, the value has fewer significant figures.
 
         >>> Decimal.from_float(0.1)
         Decimal('0.1000000000000000055511151231257827021181583404541015625')
@@ -2115,28 +2122,7 @@ def _power_exact(self, other, p):
         return _dec_from_triple(0, str_xc + "0" * zeros, xe - zeros)
 
     def __pow__(self, other, *, context=None):
-        """Return self ** other [ % modulo].
-
-        With two arguments, compute self**other.
-
-        With three arguments, compute (self**other) % modulo.  For the
-        three argument form, the following restrictions on the
-        arguments hold:
-
-         - all three arguments must be integral
-         - other must be nonnegative
-         - either self or other (or both) must be nonzero
-         - modulo must be nonzero and must have at most p digits,
-           where p is the context precision.
-
-        If any of these restrictions is violated the InvalidOperation
-        flag is raised.
-
-        The result of pow(self, other, modulo) is identical to the
-        result that would be obtained by computing (self**other) %
-        modulo with unbounded precision, but is computed more
-        efficiently.  It is always exact.
-        """
+        """Return self ** other."""
 
         other = _convert_other(other)
         if other is NotImplemented:
@@ -3396,20 +3382,16 @@ def __exit__(self, t, v, tb):
 class Context(object):
     """Contains the context for a Decimal instance.
 
-    Contains:
-    prec - precision (for use in rounding, division, square roots..)
-    rounding - rounding type (how you round)
-    traps - If traps[exception] = 1, then the exception is
-                    raised when it is caused.  Otherwise, a value is
-                    substituted in.
-    flags  - When an exception is caused, flags[exception] is set.
-             (Whether or not the trap_enabler is set)
-             Should be reset by user of Decimal instance.
-    Emin -   Minimum exponent
-    Emax -   Maximum exponent
-    capitals -      If 1, 1*10^1 is printed as 1E+1.
-                    If 0, printed as 1e1
-    clamp -  If 1, change exponents if too high (Default 0)
+    :param int prec: precision (for use in rounding, division, square roots..)
+    :param str rounding: rounding type (how you round)
+    :param dict traps: if traps[exception] = 1, then the exception is
+                       raised when it is caused.  Otherwise, a value is
+                       substituted in.
+    :param dict flags: when an exception is caused, flags[exception] is set.  (Whether or not the trap_enabler is set) Should be reset by user of Decimal instance.
+    :param int Emin: minimum exponent
+    :param int Emax: maximum exponent
+    :param bool capitals: if true, 1*10^1 is printed as 1E+1, else printed as 1e1
+    :param bool clamp: If true, change exponents if too high
     """
 
     def __init__(

jepler_udecimal/__init__.py

@@ -53,7 +53,5 @@
     "precision math",
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
-    # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
-    #       CHANGE `py_modules=['...']` TO `packages=['...']`
-    py_modules=["jepler_udecimal"],
+    packages=["jepler_udecimal"],
 )