#936 update docs

pybamm-team · Apr 5, 2020 · d6b1a9e · d6b1a9e
1 parent 877f183
commit d6b1a9e
Show file tree

Hide file tree

Showing 24 changed files with 24 additions and 24 deletions.
diff --git a/...ut/parameters/lithium-ion/anodes/graphite_Chen2020/graphite_LGM50_diffusivity_Chen2020.py b/...ut/parameters/lithium-ion/anodes/graphite_Chen2020/graphite_LGM50_diffusivity_Chen2020.py
@@ -22,7 +22,7 @@ def graphite_LGM50_diffusivity_Chen2020(sto, T):
 
       Returns
       -------
-      : double
+      :class:`pybamm.Symbol`
          Solid diffusivity
    """
 

diff --git a/.../input/parameters/lithium-ion/anodes/graphite_Ecker2015/graphite_diffusivity_Ecker2015.py b/.../input/parameters/lithium-ion/anodes/graphite_Ecker2015/graphite_diffusivity_Ecker2015.py
@@ -26,7 +26,7 @@ def graphite_diffusivity_Ecker2015(sto, T):
 
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Solid diffusivity
    """
 

diff --git a/...input/parameters/lithium-ion/anodes/graphite_Ecker2015/graphite_ocp_Ecker2015_function.py b/...input/parameters/lithium-ion/anodes/graphite_Ecker2015/graphite_ocp_Ecker2015_function.py
@@ -24,7 +24,7 @@ def graphite_ocp_Ecker2015_function(sto):
 
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Open circuit potential
     """
 

diff --git a/pybamm/input/parameters/lithium-ion/anodes/graphite_Kim2011/graphite_diffusivity_Kim2011.py b/pybamm/input/parameters/lithium-ion/anodes/graphite_Kim2011/graphite_diffusivity_Kim2011.py
@@ -21,7 +21,7 @@ def graphite_diffusivity_Kim2011(sto, T):
 
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Solid diffusivity
    """
 

diff --git a/.../parameters/lithium-ion/anodes/graphite_UMBL_Mohtat2020/graphite_diffusivity_PeymanMPM.py b/.../parameters/lithium-ion/anodes/graphite_UMBL_Mohtat2020/graphite_diffusivity_PeymanMPM.py
@@ -19,7 +19,7 @@ def graphite_diffusivity_PeymanMPM(sto, T):
 
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Solid diffusivity
    """
 

diff --git a/...ameters/lithium-ion/anodes/graphite_UMBL_Mohtat2020/graphite_entropic_change_PeymanMPM.py b/...ameters/lithium-ion/anodes/graphite_UMBL_Mohtat2020/graphite_entropic_change_PeymanMPM.py
@@ -10,7 +10,7 @@ def graphite_entropic_change_PeymanMPM(sto, c_n_max):
 
           Parameters
           ----------
-          sto: double
+          sto : :class:`pybamm.Symbol`
                Stochiometry of material (li-fraction)
 
     """

diff --git a/...rs/lithium-ion/anodes/graphite_mcmb2528_Marquis2019/graphite_entropic_change_Moura2016.py b/...rs/lithium-ion/anodes/graphite_mcmb2528_Marquis2019/graphite_entropic_change_Moura2016.py
@@ -13,7 +13,7 @@ def graphite_entropic_change_Moura2016(sto, c_n_max):
 
           Parameters
           ----------
-          sto: double
+          sto : :class:`pybamm.Symbol`
                Stochiometry of material (li-fraction)
 
     """

diff --git a/...um-ion/anodes/graphite_mcmb2528_Marquis2019/graphite_mcmb2528_diffusivity_Dualfoil1998.py b/...um-ion/anodes/graphite_mcmb2528_Marquis2019/graphite_mcmb2528_diffusivity_Dualfoil1998.py
@@ -19,7 +19,7 @@ def graphite_mcmb2528_diffusivity_Dualfoil1998(sto, T):
 
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Solid diffusivity
    """
 

diff --git a/pybamm/input/parameters/lithium-ion/cathodes/LiNiCoO2_Ecker2015/nco_diffusivity_Ecker2015.py b/pybamm/input/parameters/lithium-ion/cathodes/LiNiCoO2_Ecker2015/nco_diffusivity_Ecker2015.py
@@ -26,7 +26,7 @@ def nco_diffusivity_Ecker2015(sto, T):
 
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Solid diffusivity
     """
 

diff --git a/...meters/lithium-ion/cathodes/LiNiCoO2_Ecker2015/nco_electrolyte_reaction_rate_Ecker2015.py b/...meters/lithium-ion/cathodes/LiNiCoO2_Ecker2015/nco_electrolyte_reaction_rate_Ecker2015.py
@@ -23,7 +23,7 @@ def nco_electrolyte_reaction_rate_Ecker2015(T):
         Dimensional temperature
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Reaction rate
     """
 

diff --git a/...mm/input/parameters/lithium-ion/cathodes/LiNiCoO2_Ecker2015/nco_ocp_Ecker2015_function.py b/...mm/input/parameters/lithium-ion/cathodes/LiNiCoO2_Ecker2015/nco_ocp_Ecker2015_function.py
@@ -19,7 +19,7 @@ def nco_ocp_Ecker2015_function(sto):
 
     Parameters
     ----------
-    sto: double
+    sto : :class:`pybamm.Symbol`
        Stochiometry of material (li-fraction)
 
     """

diff --git a/...mm/input/parameters/lithium-ion/cathodes/NMC_UMBL_Mohtat2020/NMC_diffusivity_PeymanMPM.py b/...mm/input/parameters/lithium-ion/cathodes/NMC_UMBL_Mohtat2020/NMC_diffusivity_PeymanMPM.py
@@ -19,7 +19,7 @@ def NMC_diffusivity_PeymanMPM(sto, T):
 
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Solid diffusivity
     """
 

diff --git a/...eters/lithium-ion/cathodes/NMC_UMBL_Mohtat2020/NMC_electrolyte_reaction_rate_PeymanMPM.py b/...eters/lithium-ion/cathodes/NMC_UMBL_Mohtat2020/NMC_electrolyte_reaction_rate_PeymanMPM.py
@@ -15,7 +15,7 @@ def NMC_electrolyte_reaction_rate_PeymanMPM(T):
         Dimensional temperature
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Reaction rate
     """
     m_ref = 4.824 * 10 ** (-6)

diff --git a/...nput/parameters/lithium-ion/cathodes/NMC_UMBL_Mohtat2020/NMC_entropic_change_PeymanMPM.py b/...nput/parameters/lithium-ion/cathodes/NMC_UMBL_Mohtat2020/NMC_entropic_change_PeymanMPM.py
@@ -15,7 +15,7 @@ def NMC_entropic_change_PeymanMPM(sto, c_p_max):
 
           Parameters
           ----------
-          sto: double
+          sto : :class:`pybamm.Symbol`
                Stochiometry of material (li-fraction)
 
     """

diff --git a/pybamm/input/parameters/lithium-ion/cathodes/NMC_UMBL_Mohtat2020/NMC_ocp_PeymanMPM.py b/pybamm/input/parameters/lithium-ion/cathodes/NMC_UMBL_Mohtat2020/NMC_ocp_PeymanMPM.py
@@ -12,7 +12,7 @@ def NMC_ocp_PeymanMPM(sto):
 
     Parameters
     ----------
-    sto: double
+    sto : :class:`pybamm.Symbol`
        Stochiometry of material (li-fraction)
 
     """

diff --git a/...input/parameters/lithium-ion/cathodes/lico2_Marquis2019/lico2_diffusivity_Dualfoil1998.py b/...input/parameters/lithium-ion/cathodes/lico2_Marquis2019/lico2_diffusivity_Dualfoil1998.py
@@ -19,7 +19,7 @@ def lico2_diffusivity_Dualfoil1998(sto, T):
 
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Solid diffusivity
     """
     D_ref = 1 * 10 ** (-13)

diff --git a/...rs/lithium-ion/cathodes/lico2_Marquis2019/lico2_electrolyte_reaction_rate_Dualfoil1998.py b/...rs/lithium-ion/cathodes/lico2_Marquis2019/lico2_electrolyte_reaction_rate_Dualfoil1998.py
@@ -16,7 +16,7 @@ def lico2_electrolyte_reaction_rate_Dualfoil1998(T):
 
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Reaction rate
     """
     m_ref = 6 * 10 ** (-7)

diff --git a/...nput/parameters/lithium-ion/cathodes/lico2_Marquis2019/lico2_entropic_change_Moura2016.py b/...nput/parameters/lithium-ion/cathodes/lico2_Marquis2019/lico2_entropic_change_Moura2016.py
@@ -13,7 +13,7 @@ def lico2_entropic_change_Moura2016(sto, c_p_max):
 
           Parameters
           ----------
-          sto: double
+          sto : :class:`pybamm.Symbol`
                Stochiometry of material (li-fraction)
 
     """

diff --git a/pybamm/input/parameters/lithium-ion/cathodes/lico2_Marquis2019/lico2_ocp_Dualfoil1998.py b/pybamm/input/parameters/lithium-ion/cathodes/lico2_Marquis2019/lico2_ocp_Dualfoil1998.py
@@ -18,7 +18,7 @@ def lico2_ocp_Dualfoil1998(sto):
 
     Parameters
     ----------
-    sto: double
+    sto : :class:`pybamm.Symbol`
        Stochiometry of material (li-fraction)
 
     """

diff --git a/pybamm/input/parameters/lithium-ion/cathodes/nca_Kim2011/nca_diffusivity_Kim2011.py b/pybamm/input/parameters/lithium-ion/cathodes/nca_Kim2011/nca_diffusivity_Kim2011.py
@@ -21,7 +21,7 @@ def nca_diffusivity_Kim2011(sto, T):
 
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Solid diffusivity
     """
 

diff --git a/...nput/parameters/lithium-ion/cathodes/nca_Kim2011/nca_electrolyte_reaction_rate_Kim2011.py b/...nput/parameters/lithium-ion/cathodes/nca_Kim2011/nca_electrolyte_reaction_rate_Kim2011.py
@@ -19,7 +19,7 @@ def nca_electrolyte_reaction_rate_Kim2011(T):
         Dimensional temperature
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Reaction rate
     """
     i0_ref = 4  # reference exchange current density at 100% SOC

diff --git a/pybamm/input/parameters/lithium-ion/cathodes/nca_Kim2011/nca_ocp_Kim2011_function.py b/pybamm/input/parameters/lithium-ion/cathodes/nca_Kim2011/nca_ocp_Kim2011_function.py
@@ -14,7 +14,7 @@ def nca_ocp_Kim2011_function(sto):
 
     Parameters
     ----------
-    sto: double
+    sto : :class:`pybamm.Symbol`
        Stochiometry of material (li-fraction)
 
     """

diff --git a/pybamm/input/parameters/lithium-ion/cathodes/nmc_Chen2020/nmc_LGM50_diffusivity_Chen2020.py b/pybamm/input/parameters/lithium-ion/cathodes/nmc_Chen2020/nmc_LGM50_diffusivity_Chen2020.py
@@ -20,7 +20,7 @@ def nmc_LGM50_diffusivity_Chen2020(sto, T):
 
        Returns
        -------
-       : double
+       :class:`pybamm.Symbol`
           Solid diffusivity
     """
 

diff --git a/...ameters/lithium-ion/cathodes/nmc_Chen2020/nmc_LGM50_electrolyte_reaction_rate_Chen2020.py b/...ameters/lithium-ion/cathodes/nmc_Chen2020/nmc_LGM50_electrolyte_reaction_rate_Chen2020.py
@@ -17,7 +17,7 @@ def nmc_LGM50_electrolyte_reaction_rate_Chen2020(T):
 
     Returns
     -------
-    : double
+    :class:`pybamm.Symbol`
         Reaction rate
     """
     m_ref = 3.59e-6
-Original file line number
+Diff line change
@@ Expand Up / @@ -22,7 +22,7 @@ def graphite_LGM50_diffusivity_Chen2020(sto, T): @@
           Returns
           -------
-          : double
+          :class:`pybamm.Symbol`
              Solid diffusivity
        """
@@ Expand Down @@