summaryrefslogtreecommitdiff
path: root/gnuradio-runtime/python/pmt/__init__.py
diff options
context:
space:
mode:
authorBen Reynwar <ben@reynwar.net>2013-05-19 02:55:33 -0700
committerBen Reynwar <ben@reynwar.net>2013-05-19 02:55:33 -0700
commitbb01988e75d50d82cbb44c1a49c86c1d08f05665 (patch)
tree0528dac14476d37f2cde7374a8fcb3428f879c69 /gnuradio-runtime/python/pmt/__init__.py
parente4f0319eced22c112f7e6a4cc45bc2036d285332 (diff)
parent0fa219774dcf9141ae91204f948c029b05673f3f (diff)
Merged in next_docs branch.
Diffstat (limited to 'gnuradio-runtime/python/pmt/__init__.py')
-rw-r--r--gnuradio-runtime/python/pmt/__init__.py16
1 files changed, 15 insertions, 1 deletions
diff --git a/gnuradio-runtime/python/pmt/__init__.py b/gnuradio-runtime/python/pmt/__init__.py
index 0d995c24a4..00940e4cc1 100644
--- a/gnuradio-runtime/python/pmt/__init__.py
+++ b/gnuradio-runtime/python/pmt/__init__.py
@@ -22,7 +22,21 @@
# The presence of this file turns this directory into a Python package
'''
-The GNU Radio Utility Etcetera Library's Polymorphic Types for Python.
+Polymorphic Types.
+
+The type can really be used to store anything, but also has simple
+conversion methods for common data types such as bool, long, or a
+vector.
+
+The polymorphic type simplifies message passing between blocks, as all
+of the data is of the same type, including the message. Tags also use
+PMTs as data type, so a stream tag can be of any logical data type. In
+a sense, PMTs are a way to extend C++' strict typing with something
+more flexible.
+
+The PMT library supports the following major types:
+bool, symbol (string), integer, real, complex, null, pair, list,
+vector, dict, uniform_vector, any (boost::any cast)
'''
import os