Documentation improvements.

ggventurini · Apr 14, 2014 · e3d8d7e · e3d8d7e
1 parent f0345ee
commit e3d8d7e
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 41 deletions.
diff --git a/deltasigma/__init__.py b/deltasigma/__init__.py
@@ -248,10 +248,10 @@
 Why this project was born
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-I like challenges, Delta Sigma modulation and I don't have the money for
+I like challenges, delta-sigma modulation and I don't have the money for
 my own MATLAB license.
 
-With this Python package you can simulate Delta Sigma modulators for
+With this Python package you can simulate delta-sigma modulators for
 free, on any PC.
 
 I hope you find it useful.
@@ -500,6 +500,35 @@
     pulse
     rmsGain
 
+Utility functions for simulation of delta-sigma modulators
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Functions for low-level handling of delta-sigma modulator representations,
+their evaluation and filtering.
+
+.. autosummary::
+    :nosignatures:
+
+    bquantize
+    bunquantize
+    cancelPZ
+    circshift
+    delay
+    ds_f1f2
+    ds_freq
+    ds_hann
+    ds_optzeros
+    ds_quantize
+    ds_synNTFobj1
+    dsclansNTF
+    evalMixedTF
+    evalRPoly
+    evalTF
+    nabsH
+    peakSNR
+    sinc_decimate
+    zinc
+
 General utilities for data processing
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -524,6 +553,7 @@
     padt
     cplxpair
     mfloor
+    mround
     rat
     gcd
     lcm
@@ -543,49 +573,20 @@
     PlotExampleSpectrum
     axisLabels
     bilogplot
-    bplogsmooth
     lollipop
     changeFig
 
-Textual and non-graphic functions
+Textual and non-graphic display-related functions
 
 .. autosummary::
     :nosignatures:
 
     circ_smooth
+    bplogsmooth
     logsmooth
     pretty_lti
     SIunits
 
-Utility functions for Delta Sigma simulation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Functions for low-level handling of Delta Sigma modulator representations,
-their evaluation and filtering.
-
-.. autosummary::
-    :nosignatures:
-
-    bquantize
-    bunquantize
-    cancelPZ
-    circshift
-    delay
-    ds_f1f2
-    ds_freq
-    ds_hann
-    ds_optzeros
-    ds_quantize
-    ds_synNTFobj1
-    dsclansNTF
-    evalMixedTF
-    evalRPoly
-    evalTF
-    nabsH
-    peakSNR
-    sinc_decimate
-    zinc
-
 All functions in alphabetical order
 -----------------------------------
 

diff --git a/deltasigma/_db.py b/deltasigma/_db.py
@@ -24,7 +24,7 @@
 from ._dbv import dbv
 
 def db(x, input_type='voltage', R=1.):
-	"""The dB equivalent of the RMS signal ``x``.
+	"""Calculate the dB equivalent of the RMS signal ``x``.
 	
 	For input type *'voltage'*, the return value is defined as
 	

diff --git a/deltasigma/_dbm.py b/deltasigma/_dbm.py
@@ -22,7 +22,7 @@
 from ._utils import carray, save_input_form, restore_input_form
 
 def dbm(v, R=50):
-	"""The dBm equivalent of an RMS voltage ``v``.
+	"""Calculate the dBm equivalent of an RMS voltage ``v``.
 
 	.. math::
 

diff --git a/deltasigma/_dbp.py b/deltasigma/_dbp.py
@@ -21,7 +21,7 @@
 from ._utils import carray, save_input_form, restore_input_form
 
 def dbp(x):
-	"""The dB equivalent of the power ratio ``x``.
+	"""Calculate the dB equivalent of the power ratio ``x``.
 
 	.. math::
 

diff --git a/deltasigma/_dbv.py b/deltasigma/_dbv.py
@@ -23,7 +23,7 @@
 from ._utils import carray, save_input_form, restore_input_form
 
 def dbv(x):
-	"""The dB equivalent of the voltage ratio ``x``.
+	"""Calculate the dB equivalent of the voltage ratio ``x``.
 
 	.. math::
 

diff --git a/deltasigma/_mapCtoD.py b/deltasigma/_mapCtoD.py
@@ -33,7 +33,7 @@
 from ._utils import _getABCD
 
 def mapCtoD(sys_c, t=(0, 1), f0=0.):
-    """Map a MIMO continuous-time system to a SIMO discrete-time equivalent.
+    """Map a MIMO continuous-time to an equiv. SIMO discrete-time system.
 
     The criterion for equivalence is that the sampled pulse response
     of the CT system must be identical to the impulse response of the DT system.

diff --git a/deltasigma/_rms.py b/deltasigma/_rms.py
@@ -21,7 +21,7 @@
 import numpy.linalg as la
 
 def rms(x, no_dc=False):
-	"""Calculates the RMS value of x
+	"""Calculate the RMS value of ``x``.
 
 	The Root Mean Square value of an array :math:`x` of length :math:`n` is defined as:
 

diff --git a/doc/index.rst b/doc/index.rst
@@ -8,10 +8,10 @@
    \fancyhead[LE]{}
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
 .. automodule:: deltasigma.__init__
-    :members: DocumentNTF, PlotExampleSpectrum, SIunits, axisLabels, bilogplot, bplogsmooth, bquantize, bunquantize, calculateSNR, calculateTF, cancelPZ, changeFig, circ_smooth, circshift, clans, eps, db, dbm, dbp, dbv, delay, ds_f1f2, ds_freq, ds_hann, ds_optzeros, ds_quantize, ds_synNTFobj1, dsclansNTF, evalMixedTF, evalRPoly, evalTF, evalTFP, figureMagic, frespF1, impL1, infnorm, l1norm, logsmooth, lollipop, mapABCD, mapCtoD, mapQtoR, mapRtoQ, mod1, mod2, nabsH, padb, padl, padr, padt, partitionABCD, peakSNR, plotPZ, plotSpectrum, predictSNR, pulse, realizeNTF, realizeNTF_ct, rms, rmsGain, scaleABCD, simulateDSM, simulateSNR, sinc_decimate, stuffABCD, synthesizeChebyshevNTF, synthesizeNTF, undbm, undbp, undbv, cplxpair, mfloor, pretty_lti, rat, gcd, lcm, zinc
+    :members: DocumentNTF, PlotExampleSpectrum, SIunits, axisLabels, bilogplot, bplogsmooth, bquantize, bunquantize, calculateSNR, calculateTF, cancelPZ, changeFig, circ_smooth, circshift, clans, eps, db, dbm, dbp, dbv, delay, ds_f1f2, ds_freq, ds_hann, ds_optzeros, ds_quantize, ds_synNTFobj1, dsclansNTF, evalMixedTF, evalRPoly, evalTF, evalTFP, figureMagic, frespF1, impL1, infnorm, l1norm, logsmooth, lollipop, mapABCD, mapCtoD, mapQtoR, mapRtoQ, mod1, mod2, nabsH, padb, padl, padr, padt, partitionABCD, peakSNR, plotPZ, plotSpectrum, predictSNR, pulse, realizeNTF, realizeNTF_ct, rms, rmsGain, scaleABCD, simulateDSM, simulateSNR, sinc_decimate, stuffABCD, synthesizeChebyshevNTF, synthesizeNTF, undbm, undbp, undbv, cplxpair, mfloor, mround, pretty_lti, rat, gcd, lcm, zinc