Changeset 69fee24 in sasview for calculator/docs/sphinx/_build/html/api

Timestamp:

May 28, 2010 1:37:18 PM (14 years ago)

Author:

Gervaise Alina <gervyh@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

ddf6df3

Parents:

25a2ee3

Message:

working on documentation

File:

• calculator/docs/sphinx/_build/html/api/slit_length_calculator.html (modified) (1 diff)

calculator/docs/sphinx/_build/html/api/slit_length_calculator.html

@@ -65 +65 @@
 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length">
 <tt class="descname">calculate_slit_length</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.calculate_slit_length" title="Permalink to this definition">¶</a></dt>
-<dd>Calculate slit length.</dd></dl>
+<dd><p>Calculate slit length.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the slit length calculated value.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 <dl class="method">
 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.get_slit_length_unit">
 <tt class="descname">get_slit_length_unit</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.get_slit_length_unit" title="Permalink to this definition">¶</a></dt>
-<dd>return the slit length unit.</dd></dl>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the slit length unit.</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 <dl class="method">
 <dt id="sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data">
 <tt class="descname">set_data</tt><big>(</big><em>x=None</em>, <em>y=None</em><big>)</big><a class="headerlink" href="#sans.calculator.slit_length_calculator.SlitlengthCalculator.set_data" title="Permalink to this definition">¶</a></dt>
-<dd>set data
-:param x, y: x array and y array</dd></dl>
+<dd><blockquote>
+Receive two vector x, y and prepare the slit calculator for 
+computation.</blockquote>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><strong>x</strong> &#8211; array</li>
+<li><strong>y</strong> &#8211; array</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 </dd></dl>