diff options
| author | Gary E. Miller <gem@rellim.com> | 2018-09-22 13:12:32 -0700 |
|---|---|---|
| committer | Gary E. Miller <gem@rellim.com> | 2018-09-22 13:12:32 -0700 |
| commit | d692a0b995d8147ef3e2d32722db9bdedf13c8a3 (patch) | |
| tree | 159f79b52cc8bed7fca001a84fe4b9d88e34ac27 /gps | |
| parent | e86d1e731d4346515e102fbc8effd8f8708081cf (diff) | |
| download | gpsd-d692a0b995d8147ef3e2d32722db9bdedf13c8a3.tar.gz | |
Python modules: add module docstrings.
Diffstat (limited to 'gps')
| -rw-r--r-- | gps/client.py | 1 | ||||
| -rw-r--r-- | gps/gps.py | 21 | ||||
| -rw-r--r-- | gps/misc.py | 1 | ||||
| -rw-r--r-- | gps/watch_options.py | 2 |
4 files changed, 14 insertions, 11 deletions
diff --git a/gps/client.py b/gps/client.py index a1a5b68f..6ff9ce71 100644 --- a/gps/client.py +++ b/gps/client.py @@ -1,3 +1,4 @@ +"gpsd client functions" # This file is Copyright (c) 2010 by the GPSD project # BSD terms apply: see the file COPYING in the distribution root for details. # @@ -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! diff --git a/gps/misc.py b/gps/misc.py index bc89bf99..a312c563 100644 --- a/gps/misc.py +++ b/gps/misc.py @@ -1,4 +1,5 @@ # misc.py - miscellaneous geodesy and time functions +"miscellaneous geodesy and time functions" # # This file is Copyright (c) 2010 by the GPSD project # BSD terms apply: see the file COPYING in the distribution root for details. diff --git a/gps/watch_options.py b/gps/watch_options.py index 7c1fde15..c6ba885d 100644 --- a/gps/watch_options.py +++ b/gps/watch_options.py @@ -1,4 +1,4 @@ -# WATCH options - controls what data is streamed, and how it's converted +"WATCH options - controls what data is streamed, and how it's converted" WATCH_ENABLE = 0x000001 # enable streaming WATCH_DISABLE = 0x000002 # disable watching WATCH_JSON = 0x000010 # JSON output |