#759 add docs for event

pybamm-team · Feb 6, 2020 · 3a0001f · 3a0001f
1 parent d844228
commit 3a0001f
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/docs/source/models/base_models/index.rst b/docs/source/models/base_models/index.rst
@@ -6,3 +6,4 @@ Base Models
 
   base_model
   base_battery_model
+  event
diff --git a/pybamm/models/base_model.py b/pybamm/models/base_model.py
@@ -46,7 +46,7 @@ class BaseModel(object):
     variables: dict
         A dictionary that maps strings to expressions that represent
         the useful variables
-    events: list of pybamm.Event
+    events: list of :class:`pybamm.Event`
         A list of events. Each event can either cause the solver to terminate
         (e.g. concentration goes negative), or be used to inform the solver of the
         existance of a discontinuity (e.g. discontinuity in the input current)

diff --git a/pybamm/models/event.py b/pybamm/models/event.py
@@ -3,7 +3,7 @@
 
 class EventType(Enum):
     """
-    Defines the type of event, see Event
+    Defines the type of event, see :class:`pybamm.Event`
 
     TERMINATION indicates an event that will terminate the solver, the expression should
     return 0 when the event is triggered
@@ -27,9 +27,9 @@ class Event:
 
     name: str
         A string giving the name of the event
-    event_type: EventType
+    event_type: :class:`pybamm.EventType`
         An enum defining the type of event
-    expression: pybamm.Symbol
+    expression: :class:`pybamm.Symbol`
         An expression that defines when the event occurs