From 43f7e4fae3fd3787eccc394aa894856ea2679863 Mon Sep 17 00:00:00 2001
From: Mark Driver <mdd31@alumni.cam.ac.uk>
Date: Tue, 18 Feb 2020 19:46:24 +0000
Subject: [PATCH] update documentation.
---
phasecalculator/classes/phases.py | 12 ++++++++++++
phasecalculator/classes/system.py | 28 ++++++++++++++++++++++++++++
2 files changed, 40 insertions(+)
diff --git a/phasecalculator/classes/phases.py b/phasecalculator/classes/phases.py
index 2a164b5..6b5a86f 100755
--- a/phasecalculator/classes/phases.py
+++ b/phasecalculator/classes/phases.py
@@ -33,6 +33,18 @@ class Phases(object):
"""Phases class."""
def __init__(self, phase_list):
+ """Initialise Phases.
+
+ Parameters
+ ----------
+ phase_list : list of Phase objects.
+ Phases for calculation.
+
+ Returns
+ -------
+ New Phases Instance.
+
+ """
self.phase_list = phase_list
def __eq__(self, other):
diff --git a/phasecalculator/classes/system.py b/phasecalculator/classes/system.py
index df84650..56b8369 100755
--- a/phasecalculator/classes/system.py
+++ b/phasecalculator/classes/system.py
@@ -36,6 +36,18 @@ LOGGER.setLevel(logging.WARN)
class SystemCollection(object):
"""System Collection class."""
def __init__(self, system_list):
+ """
+
+ Parameters
+ ----------
+ system_list : list of System
+ List of systems.
+
+ Returns
+ -------
+ None.
+
+ """
self.system_list = system_list
def __eq__(self, other):
"""Overload equality comparison operator.
@@ -95,6 +107,22 @@ class SystemCollection(object):
class System(object):
"""System class"""
def __init__(self, phases, runtime_information, output_information):
+ """Initialise new System.
+
+ Parameters
+ ----------
+ phases : Phases
+ Phases of interest.
+ runtime_information : RuntimeInformation
+ Runtime parameter information.
+ output_information : OutputInformation
+ Output option information.
+
+ Returns
+ -------
+ None.
+
+ """
self.phases = phases
self.runtime_information = runtime_information
self.output_information = output_information
--
GitLab