summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--gnuradio-core/src/python/gnuradio/__init__.py13
-rw-r--r--gnuradio-core/src/python/gnuradio/blks2/__init__.py3
-rw-r--r--gnuradio-core/src/python/gnuradio/eng_notation.py3
-rw-r--r--gnuradio-core/src/python/gnuradio/gr/__init__.py4
-rwxr-xr-xgnuradio-core/src/python/gnuradio/gr_unittest.py3
-rw-r--r--gr-audio/swig/__init__.py9
-rw-r--r--gr-digital/python/__init__.py3
-rw-r--r--gr-qtgui/swig/__init__.py4
-rw-r--r--gr-trellis/src/lib/trellis.i1
-rw-r--r--gr-utils/src/python/plot_data.py3
-rw-r--r--gr-wavelet/python/__init__.py3
-rw-r--r--gr-wxgui/src/python/__init__.py3
12 files changed, 41 insertions, 11 deletions
diff --git a/gnuradio-core/src/python/gnuradio/__init__.py b/gnuradio-core/src/python/gnuradio/__init__.py
index a4917cf64c..d55dac79db 100644
--- a/gnuradio-core/src/python/gnuradio/__init__.py
+++ b/gnuradio-core/src/python/gnuradio/__init__.py
@@ -1 +1,12 @@
-# make this a package
+"""
+GNU Radio is a free & open-source software development toolkit that provides signal processing blocks to implement software radios. It can be used with readily-available low-cost external RF hardware to create software-defined radios, or without hardware in a simulation-like environment. It is widely used in hobbyist, academic and commercial environments to support both wireless communications research and real-world radio systems.
+
+GNU Radio applications are primarily written using the Python programming language, while the supplied performance-critical signal-processing path is implemented in C++ using processor floating-point extensions, where available. Thus, the developer is able to implement real-time, high-throughput radio systems in a simple-to-use, rapid-application-development environment.
+
+While not primarily a simulation tool, GNU Radio does support development of signal processing algorithms using pre-recorded or generated data, avoiding the need for actual RF hardware.
+
+GNU Radio is licensed under the GNU General Public License (GPL) version 3. All of the code is copyright of the Free Software Foundation.
+"""
+
+# This file makes gnuradio a package
+# The docstring will be associated with the top level of the package.
diff --git a/gnuradio-core/src/python/gnuradio/blks2/__init__.py b/gnuradio-core/src/python/gnuradio/blks2/__init__.py
index 2dfdc77f46..1d3203ec79 100644
--- a/gnuradio-core/src/python/gnuradio/blks2/__init__.py
+++ b/gnuradio-core/src/python/gnuradio/blks2/__init__.py
@@ -18,6 +18,9 @@
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
#
+"""
+Miscellaneous contents implemented in python.
+"""
import glob
import os.path
diff --git a/gnuradio-core/src/python/gnuradio/eng_notation.py b/gnuradio-core/src/python/gnuradio/eng_notation.py
index c552a45f55..d23f9005f0 100644
--- a/gnuradio-core/src/python/gnuradio/eng_notation.py
+++ b/gnuradio-core/src/python/gnuradio/eng_notation.py
@@ -18,6 +18,9 @@
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
#
+"""
+Display numbers as strings using engineering notation.
+"""
scale_factor = {}
scale_factor['E'] = 1e18
diff --git a/gnuradio-core/src/python/gnuradio/gr/__init__.py b/gnuradio-core/src/python/gnuradio/gr/__init__.py
index 602d1119fb..525c06cf5d 100644
--- a/gnuradio-core/src/python/gnuradio/gr/__init__.py
+++ b/gnuradio-core/src/python/gnuradio/gr/__init__.py
@@ -21,6 +21,10 @@
# The presence of this file turns this directory into a Python package
+"""
+Core contents.
+"""
+
# This is the main GNU Radio python module.
# We pull the swig output and the other modules into the gnuradio.gr namespace
diff --git a/gnuradio-core/src/python/gnuradio/gr_unittest.py b/gnuradio-core/src/python/gnuradio/gr_unittest.py
index e4510a6eb9..c729566e88 100755
--- a/gnuradio-core/src/python/gnuradio/gr_unittest.py
+++ b/gnuradio-core/src/python/gnuradio/gr_unittest.py
@@ -19,6 +19,9 @@
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
#
+"""
+GNU radio specific extension of unittest.
+"""
import unittest
import gr_xmlrunner
diff --git a/gr-audio/swig/__init__.py b/gr-audio/swig/__init__.py
index ff10a8976a..7a73e3ca83 100644
--- a/gr-audio/swig/__init__.py
+++ b/gr-audio/swig/__init__.py
@@ -20,10 +20,11 @@
#
'''
-This is the gr-audio package. This package is used to connect to audio
-sources (mic-in) and sinks (speaker-out) ports on a computer. The
-underlying hardware driver is system and OS dependent and this module
-should automatically discover the correct one to use.
+Blocks to connect to audio sources (mic-in) and sinks (speaker-out)
+ports on a computer.
+
+The underlying hardware driver is system and OS dependent and this
+module should automatically discover the correct one to use.
'''
from audio_swig import *
diff --git a/gr-digital/python/__init__.py b/gr-digital/python/__init__.py
index 7c76183c9d..3599fe91c1 100644
--- a/gr-digital/python/__init__.py
+++ b/gr-digital/python/__init__.py
@@ -19,8 +19,7 @@
#
'''
-This is the gr-digital package. It contains all of the blocks,
-utilities, and examples for doing digital modulation and demodulation.
+Blocks and utilities for digital modulation and demodulation.
'''
# The presence of this file turns this directory into a Python package
diff --git a/gr-qtgui/swig/__init__.py b/gr-qtgui/swig/__init__.py
index e52e326cb3..8f3fca0f4a 100644
--- a/gr-qtgui/swig/__init__.py
+++ b/gr-qtgui/swig/__init__.py
@@ -21,4 +21,8 @@
# The presence of this file turns this directory into a Python package
+'''
+Provides a GUI interface using the Qt backend.
+'''
+
from qtgui_swig import *
diff --git a/gr-trellis/src/lib/trellis.i b/gr-trellis/src/lib/trellis.i
index 0debf5e5da..89be184041 100644
--- a/gr-trellis/src/lib/trellis.i
+++ b/gr-trellis/src/lib/trellis.i
@@ -19,6 +19,7 @@
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
+%module(docstring="Generic coding/decoding.") trellis
%include "gnuradio.i" // the common stuff
diff --git a/gr-utils/src/python/plot_data.py b/gr-utils/src/python/plot_data.py
index 242ca2a4b0..2ae3b1d5b3 100644
--- a/gr-utils/src/python/plot_data.py
+++ b/gr-utils/src/python/plot_data.py
@@ -18,6 +18,9 @@
# the Free Software Foundation, Inc., 51 Franklin Street,
# Boston, MA 02110-1301, USA.
#
+"""
+Utility to help plotting data from files.
+"""
try:
import scipy
diff --git a/gr-wavelet/python/__init__.py b/gr-wavelet/python/__init__.py
index 77e2ac7c26..cf86408e95 100644
--- a/gr-wavelet/python/__init__.py
+++ b/gr-wavelet/python/__init__.py
@@ -20,8 +20,7 @@
#
'''
-This is the gr-wavelet package. This package provides GNU Radio
-processing blocks for wavelet transforms.
+Processing blocks for wavelet transforms.
'''
from wavelet_swig import *
diff --git a/gr-wxgui/src/python/__init__.py b/gr-wxgui/src/python/__init__.py
index 68f8f4b5ea..07dbaf1620 100644
--- a/gr-wxgui/src/python/__init__.py
+++ b/gr-wxgui/src/python/__init__.py
@@ -20,6 +20,5 @@
#
'''
-This is the gr-wxgui package. This package provides a GUI interface
-using the Wx backend.
+Provides a GUI interface using the Wx backend.
'''