commit 6a6791329bddde6230bf4f5a85166bfa4a0012cb
author Mitja Nikolaus <mitja@fairphone.com> Thu Aug 30 14:35:29 2018 +0200
committer Karsten Tausche <karsten@fairphone.com> Thu Sep 13 04:54:30 2018 +0000
tree 7882b3041330168d91f9d00c998d1f8fe1061aae
parent 31882a4fce5757aa50436a5a0e99f8118b0dcb74

Add missing docstrings

Add missing docstrings to modules, classes and functions. Refactor
existing docstrings that are not correctly formatted.

Issue: HIC-170
Change-Id: I766830259b897f8c2d931f3b53ce935e82b161fd

crashreport_stats/urls.py

diff --git a/crashreport_stats/urls.py b/crashreport_stats/urls.py
index cedbd73..04b008f 100644
--- a/crashreport_stats/urls.py
+++ b/crashreport_stats/urls.py
@@ -1,28 +1,29 @@
+"""URLs for accessing the Hiccup statistics."""
+
 from django.conf.urls import url
 from . import views
 from . import rest_endpoints
 
 
 urlpatterns = [
+    # Single device statistics page
     url(r"^device/$", views.device_stats, name="hiccup_stats_device"),
+    # Home page with device search form
     url(r"^$", views.home, name="device"),
+    # Version statistics overview pages
     url(r"^versions/$", views.versions_overview, name="hiccup_stats_versions"),
     url(
         r"^versions/all/$",
         views.versions_all_overview,
         name="hiccup_stats_versions_all",
     ),
+    # Single device statistics API
     url(
         r"^api/v1/device_overview/(?P<uuid>[a-f0-9-]+)/$",
         rest_endpoints.DeviceStat.as_view(),
         name="hiccup_stats_api_v1_device_overview",
     ),
     url(
-        r"^api/v1/status/$",
-        rest_endpoints.Status.as_view(),
-        name="hiccup_stats_api_v1_status",
-    ),
-    url(
         r"^api/v1/device_update_history/(?P<uuid>[a-f0-9-]+)/$",
         rest_endpoints.DeviceUpdateHistory.as_view(),
         name="hiccup_stats_api_v1_device_update_history",
@@ -37,6 +38,7 @@
         rest_endpoints.LogFileDownload.as_view(),
         name="hiccup_stats_api_v1_logfile_download",
     ),
+    # Version statistics API
     url(
         r"^api/v1/versions/$",
         rest_endpoints.VersionListView.as_view(),
@@ -57,4 +59,10 @@
         rest_endpoints.RadioVersionDailyListView.as_view(),
         name="hiccup_stats_api_v1_radio_version_daily",
     ),
+    # General statistics API
+    url(
+        r"^api/v1/status/$",
+        rest_endpoints.Status.as_view(),
+        name="hiccup_stats_api_v1_status",
+    ),
 ]