From 89f9a7f7252d43257290a5161dd50f54d0da0045 Mon Sep 17 00:00:00 2001
From: "duncan.macleod" <duncan.macleod@ligo.org>
Date: Fri, 1 Apr 2022 16:41:28 +0100
Subject: [PATCH] ui: add missing module docstring

---
 gwdatafind/ui.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/gwdatafind/ui.py b/gwdatafind/ui.py
index d95d2af..4752b89 100644
--- a/gwdatafind/ui.py
+++ b/gwdatafind/ui.py
@@ -16,6 +16,13 @@
 # You should have received a copy of the GNU General Public License
 # along with GWDataFind.  If not, see <http://www.gnu.org/licenses/>.
 
+"""User interface functions for GWDataFind.
+
+These are all imported to the top-level namespace, so should be
+referred to in usage as ``gwdatafind.<function>`` and not
+``gwdatafind.ui.<function>``
+"""
+
 from functools import wraps
 from re import compile as compile_regex
 from urllib.parse import urlparse
-- 
GitLab