summaryrefslogtreecommitdiff
path: root/gps/gps.py
diff options
context:
space:
mode:
authorGary E. Miller <gem@rellim.com>2018-09-22 13:12:32 -0700
committerGary E. Miller <gem@rellim.com>2018-09-22 13:12:32 -0700
commitd692a0b995d8147ef3e2d32722db9bdedf13c8a3 (patch)
tree159f79b52cc8bed7fca001a84fe4b9d88e34ac27 /gps/gps.py
parente86d1e731d4346515e102fbc8effd8f8708081cf (diff)
downloadgpsd-d692a0b995d8147ef3e2d32722db9bdedf13c8a3.tar.gz
Python modules: add module docstrings.
Diffstat (limited to 'gps/gps.py')
-rw-r--r--gps/gps.py21
1 files changed, 11 insertions, 10 deletions
diff --git a/gps/gps.py b/gps/gps.py
index dd5acd93..2b17283f 100644
--- a/gps/gps.py
+++ b/gps/gps.py
@@ -1,19 +1,20 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
+'''gps.py -- Python interface to GPSD.
+
+This interface has a lot of historical cruft in it related to old
+protocol, and was modeled on the C interface. It won't be thrown
+away, but it's likely to be deprecated in favor of something more
+Pythonic.
+
+The JSON parts of this (which will be reused by any new interface)
+now live in a different module.
+'''
+
#
# This file is Copyright (c) 2010 by the GPSD project
# BSD terms apply: see the file COPYING in the distribution root for details.
#
-# gps.py -- Python interface to GPSD.
-#
-# This interface has a lot of historical cruft in it related to old
-# protocol, and was modeled on the C interface. It won't be thrown
-# away, but it's likely to be deprecated in favor of something more
-# Pythonic.
-#
-# The JSON parts of this (which will be reused by any new interface)
-# now live in a different module.
-#
# This code runs compatibly under Python 2 and 3.x for x >= 2.
# Preserve this property!