Commit 91a6b57a authored by Steven Cordwell's avatar Steven Cordwell
Browse files

improve docstring a liitle

parent 16dc03c6
...@@ -42,9 +42,9 @@ mdperr = { ...@@ -42,9 +42,9 @@ mdperr = {
} }
def check(P, R): def check(P, R):
"""Check if P and R define a valid Markov Decision Process (MDP). """Check if ``P`` and ``R`` define a valid Markov Decision Process (MDP).
Let S = number of states, A = number of actions. Let ``S`` = number of states, ``A`` = number of actions.
Parameters Parameters
--------- ---------
...@@ -62,7 +62,7 @@ def check(P, R): ...@@ -62,7 +62,7 @@ def check(P, R):
Notes Notes
----- -----
Raises an error if P and R do not define a MDP. Raises an error if ``P`` and ``R`` do not define a MDP.
Examples Examples
-------- --------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment