Changeset 627b68b in sasmodels

Timestamp:

Mar 29, 2019 9:57:43 AM (6 years ago)

Author:

smk78

Branches:

master, ticket-1257-vesicle-product, ticket_1156, ticket_822_more_unit_tests

Children:

de032da

Parents:

ef476e6

Message:

Fix doc build warning

File:

• sasmodels/models/spherical_sld.py (modified) (7 diffs)

sasmodels/models/spherical_sld.py

@@ -18 +18 @@
 sub-shell is described by a line function, with *n_steps* sub-shells per
 interface. The form factor is normalized by the total volume of the sphere.
+
+.. note::
+
+   *n_shells* must be an integer. *n_steps* must be an ODD integer.
 
 Interface shapes are as follows:
@@ -73 +77 @@
     3 \rho_\text{solvent} V(r_N)
     \Big[ \frac{\sin(qr_N) - qr_N \cos(qr_N)} {qr_N^3} \Big]
-
 
 Here we assumed that the SLDs of the core and solvent are constant in $r$.
@@ -156 +159 @@
     \end{align*}
 
-
 We assume $\rho_{\text{inter}_j} (r)$ is approximately linear
 within the sub-shell $j$.
@@ -179 +181 @@
     when $P(Q) * S(Q)$ is applied.
 
-
 References
 ----------
@@ -198 +199 @@
 * **Author:** Jae-Hie Cho **Date:** Nov 1, 2010
 * **Last Modified by:** Paul Kienzle **Date:** Dec 20, 2016
-* **Last Reviewed by:** Paul Butler **Date:** September 8, 2018
+* **Last Reviewed by:** Steve King **Date:** March 29, 2019
 * **Source added by :** Steve King **Date:** March 25, 2019
 """
@@ -207 +208 @@
 
 name = "spherical_sld"
-title = "Sperical SLD intensity calculation"
+title = "Spherical SLD intensity calculation"
 description = """
             I(q) =
@@ -219 +220 @@
 # pylint: disable=bad-whitespace, line-too-long
 #            ["name", "units", default, [lower, upper], "type", "description"],
-parameters = [["n_shells",             "",           1,      [1, 10],        "volume", "number of shells"],
+parameters = [["n_shells",             "",           1,      [1, 10],        "volume", "number of shells (must be integer)"],
               ["sld_solvent",          "1e-6/Ang^2", 1.0,    [-inf, inf],    "sld", "solvent sld"],
               ["sld[n_shells]",        "1e-6/Ang^2", 4.06,   [-inf, inf],    "sld", "sld of the shell"],