docs and a pylint fix.

instrumentkit · Apr 20, 2017 · 8a89bf8 · 8a89bf8
1 parent b5fdc5a
commit 8a89bf8
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 9 deletions.
diff --git a/doc/source/devguide/util_fns.rst b/doc/source/devguide/util_fns.rst
@@ -183,3 +183,15 @@ String Property
 .. autofunction:: string_property
 
 
+Named Structures
+================
+
+The :class:`~instruments.named_struct.NamedStruct` class can be used to represent
+C-style structures for serializing and deserializing data.
+
+.. autoclass:: instruments.named_struct.NamedStruct
+
+.. autoclass:: instruments.named_struct.Field
+
+.. autoclass:: instruments.named_struct.Padding
+
diff --git a/instruments/named_struct.py b/instruments/named_struct.py
@@ -15,17 +15,16 @@
 from future.utils import with_metaclass
 
 # DESIGN NOTES ################################################################
-"""
-This class uses the Django-like strategy described at
-    http://stackoverflow.com/a/3288988/267841
-to assign a "birthday" to each Field as it's instantiated. We can thus sort
-each Field in a NamedStruct by its birthday.
 
-Notably, this hack is not at all required on Python 3.6:
-    https://www.python.org/dev/peps/pep-0520/
+# This class uses the Django-like strategy described at
+#     http://stackoverflow.com/a/3288988/267841
+# to assign a "birthday" to each Field as it's instantiated. We can thus sort
+# each Field in a NamedStruct by its birthday.
 
-TODO: arrays other than string arrays do not currently work.
-"""
+# Notably, this hack is not at all required on Python 3.6:
+#     https://www.python.org/dev/peps/pep-0520/
+
+# TODO: arrays other than string arrays do not currently work.
 
 # PYLINT CONFIGURATION ########################################################