DOC: improvements

deltasigma/_mapQtoR.py

@@ -24,8 +24,8 @@
 def mapQtoR(ABCD):
     """Map a quadrature ABCD matrix to a real one.
 
-    Each element z in ABCD is replaced by a 2x2 matrix in ``ABCDr``, the
-    return value.
+    Each element :math:`z` in :math:`ABCD` is replaced by a 2x2 matrix in
+    ``ABCDr``, the return value.
 
     Specifically:
 
@@ -38,7 +38,12 @@ def mapQtoR(ABCD):
          \\end{bmatrix}
         \\mathrm{where}\\ x = Re(z)\\ \\mathrm{and}\\ y = Im(z)
 
-    The non-quadrature topology can be simulated with :func:`simulateDSM`.::
+    The non-quadrature topology then can be simulated with
+    :func:`simulateDSM`.
+
+    **Example:**
+
+    ::
 
         import numpy as np
         from deltasigma import *
@@ -59,8 +64,11 @@ def mapQtoR(ABCD):
         vr = simulateDSM(ur, ABCDr, nlev*np.array([[1],[1]]))
         v = vr[0,:] + 1j*vr[1, :]
 
-    Notice the example above requires the function :func:`synthesizeQNTF`,
-    which is not part of the current release of python-deltasigma.
+
+    .. note::
+
+        The scheme above often results in a shorter simulation time compared to
+        calling :func:`simulateQDSM` directly.
 
     """
     A = np.zeros((2*ABCD.shape[0], 2*ABCD.shape[1]))

pypi_description.rst

@@ -11,7 +11,7 @@ It aims to provide **a 1:1 Python port** of Richard Schreier's
 ***excellent*** `MATLAB Delta Sigma
 Toolbox <http://www.mathworks.com/matlabcentral/fileexchange/19-delta-sigma-toolbox>`__,
 the *de facto* standard tool for high-level delta sigma simulation, upon
-which it is very heavily based. |githalytics.com alpha|
+which it is very heavily based.
 
 --------------
 
@@ -126,8 +126,6 @@ Giuseppe Venturini and the python-deltasigma contributors.
 
 MATLAB is a registered trademark of The MathWorks, Inc.
 
-.. |githalytics.com alpha| image:: https://cruel-carlota.pagodabox.com/36f25accf60f391456efe66910bf84f8
-   :target: http://githalytics.com/ggventurini/python-deltasigma
 .. |Build Status| image:: https://travis-ci.org/ggventurini/python-deltasigma.png?branch=master
    :target: https://travis-ci.org/ggventurini/python-deltasigma
 .. |Coverage Status| image:: https://coveralls.io/repos/ggventurini/python-deltasigma/badge.png?branch=master