summaryrefslogtreecommitdiffstats
path: root/src/dashboard
diff options
context:
space:
mode:
authorParker Berberian <pberberian@iol.unh.edu>2019-12-19 12:39:01 -0500
committerParker Berberian <pberberian@iol.unh.edu>2020-01-28 16:09:35 -0500
commit77377d5e9362bd35a3b300df231e82ee974675e1 (patch)
tree5e3799768eb887a0259c8c21ed61123cdde2d608 /src/dashboard
parent899e1a4baa95d0bc6f0eef34de66f0e257174878 (diff)
Comments and Documentation
This change adds a ton of comments and documentation across all the code. Change-Id: Ifee0a2f534e8584f14b0f13af4dda8dc70eb7553 Signed-off-by: Parker Berberian <pberberian@iol.unh.edu>
Diffstat (limited to 'src/dashboard')
-rw-r--r--src/dashboard/exceptions.py20
-rw-r--r--src/dashboard/populate_db_iol.py2
-rw-r--r--src/dashboard/tasks.py4
-rw-r--r--src/dashboard/urls.py3
4 files changed, 13 insertions, 16 deletions
diff --git a/src/dashboard/exceptions.py b/src/dashboard/exceptions.py
index 7111bf8..61df145 100644
--- a/src/dashboard/exceptions.py
+++ b/src/dashboard/exceptions.py
@@ -9,30 +9,26 @@
class ResourceProvisioningException(Exception):
- """
- Resources could not be provisioned
- """
+ """Resources could not be provisioned."""
+
pass
class ModelValidationException(Exception):
- """
- Validation before saving model returned issues
- """
+ """Validation before saving model returned issues."""
+
pass
class ResourceAvailabilityException(ResourceProvisioningException):
- """
- Requested resources are not *currently* available
- """
+ """Requested resources are not *currently* available."""
+
pass
class ResourceExistenceException(ResourceAvailabilityException):
- """
- Requested resources do not exist or do not match any known resources
- """
+ """Requested resources do not exist or do not match any known resources."""
+
pass
diff --git a/src/dashboard/populate_db_iol.py b/src/dashboard/populate_db_iol.py
index 57ebd40..d8df03f 100644
--- a/src/dashboard/populate_db_iol.py
+++ b/src/dashboard/populate_db_iol.py
@@ -216,6 +216,8 @@ class Populator:
def make_profile_data(self):
"""
+ Create Profile Data.
+
returns a dictionary of data from the yaml files
created by inspection scripts
"""
diff --git a/src/dashboard/tasks.py b/src/dashboard/tasks.py
index 71afed2..ac4d36f 100644
--- a/src/dashboard/tasks.py
+++ b/src/dashboard/tasks.py
@@ -88,9 +88,7 @@ def booking_poll():
@shared_task
def free_hosts():
- """
- gets all hosts from the database that need to be freed and frees them
- """
+ """Free all hosts that should be freed."""
undone_statuses = [JobStatus.NEW, JobStatus.CURRENT, JobStatus.ERROR]
undone_jobs = Job.objects.filter(
hostnetworkrelation__status__in=undone_statuses,
diff --git a/src/dashboard/urls.py b/src/dashboard/urls.py
index 60334f6..d5dad57 100644
--- a/src/dashboard/urls.py
+++ b/src/dashboard/urls.py
@@ -9,7 +9,8 @@
##############################################################################
-"""laas_dashboard URL Configuration
+"""
+laas_dashboard URL Configuration.
The `urlpatterns` list routes URLs to views. For more information please see:
https://docs.djangoproject.com/en/1.10/topics/http/urls/