[cig-commits] [commit] doc_updates: Add note to set_method documentation. (1ab7a08)

[cig_noreply at geodynamics.org]

Repository : https://github.com/geodynamics/burnman

On branch  : doc_updates
Link       : https://github.com/geodynamics/burnman/compare/0116539db4a8ba7cf7de063247d44630c4429162...1ab7a08f00ad7f036053013a7b7b187b06456c48

>---------------------------------------------------------------

commit 1ab7a08f00ad7f036053013a7b7b187b06456c48
Author: ian-r-rose <ian.r.rose at gmail.com>
Date:   Sun Jan 4 17:56:28 2015 -0800

    Add note to set_method documentation.


>---------------------------------------------------------------

1ab7a08f00ad7f036053013a7b7b187b06456c48
 burnman/mineral.py | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/burnman/mineral.py b/burnman/mineral.py
index 5776fd5..81c06cf 100644
--- a/burnman/mineral.py
+++ b/burnman/mineral.py
@@ -47,9 +47,12 @@ class Mineral(Material):
         """
         Set the equation of state to be used for this mineral.
         Takes a string corresponding to any of the predefined
-        equations of state:  'bm2', 'bm3', 'mgd2', 'mgd3', 'slb2',
-        'slb3' or 'mtait'.  Alternatively, you can pass a user defined
+        equations of state:  'bm2', 'bm3', 'mgd2', 'mgd3', 'slb2', 'slb3',
+        'mt', 'hp_tmt', or 'cork'.  Alternatively, you can pass a user defined
         class which derives from the equation_of_state base class.
+        After calling set_method(), any existing derived properties
+        (e.g., elastic parameters or thermodynamic potentials) will be out
+        of date, so set_state() will need to be called again.
         """
 
         if equation_of_state is None: