update docs

Open-Science-Tools · Mar 8, 2017 · 248bbb1 · 248bbb1
1 parent 3db501b
commit 248bbb1
Show file tree

Hide file tree

Showing 7 changed files with 638 additions and 57 deletions.
diff --git a/_modules/nd2reader/common.html b/_modules/nd2reader/common.html
@@ -119,6 +119,16 @@ <h1>Source code for nd2reader.common</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="read_array"><a class="viewcode-back" href="../../nd2reader.html#nd2reader.common.read_array">[docs]</a><span class="k">def</span> <span class="nf">read_array</span><span class="p">(</span><span class="n">fh</span><span class="p">,</span> <span class="n">kind</span><span class="p">,</span> <span class="n">chunk_location</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        fh:</span>
+<span class="sd">        kind:</span>
+<span class="sd">        chunk_location:</span>
+
+<span class="sd">    Returns:</span>
+
+<span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">kinds</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;double&#39;</span><span class="p">:</span> <span class="s1">&#39;d&#39;</span><span class="p">,</span>
              <span class="s1">&#39;int&#39;</span><span class="p">:</span> <span class="s1">&#39;i&#39;</span><span class="p">,</span>
              <span class="s1">&#39;float&#39;</span><span class="p">:</span> <span class="s1">&#39;f&#39;</span><span class="p">}</span>
@@ -160,10 +170,13 @@ <h1>Source code for nd2reader.common</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="parse_date"><a class="viewcode-back" href="../../nd2reader.html#nd2reader.common.parse_date">[docs]</a><span class="k">def</span> <span class="nf">parse_date</span><span class="p">(</span><span class="n">text_info</span><span class="p">):</span>
-    <span class="sd">&quot;&quot;&quot;The date and time when acquisition began.</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    The date and time when acquisition began.</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        text_info:</span>
 
 <span class="sd">    Returns:</span>
-<span class="sd">        datetime: The date and time when acquisition began.</span>
 
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">text_info</span><span class="o">.</span><span class="n">values</span><span class="p">():</span>
@@ -183,8 +196,11 @@ <h1>Source code for nd2reader.common</h1><div class="highlight"><pre>
 <span class="k">def</span> <span class="nf">_parse_metadata_item</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">cursor_position</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Reads hierarchical data, analogous to a Python dict.</span>
 
+<span class="sd">    Args:</span>
+<span class="sd">        data:</span>
+<span class="sd">        cursor_position:</span>
+
 <span class="sd">    Returns:</span>
-<span class="sd">        dict: the metadata item</span>
 
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">new_count</span><span class="p">,</span> <span class="n">length</span> <span class="o">=</span> <span class="n">struct</span><span class="o">.</span><span class="n">unpack</span><span class="p">(</span><span class="s2">&quot;&lt;IQ&quot;</span><span class="p">,</span> <span class="n">data</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="mi">12</span><span class="p">))</span>
@@ -199,6 +215,13 @@ <h1>Source code for nd2reader.common</h1><div class="highlight"><pre>
 <span class="k">def</span> <span class="nf">_get_value</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">data_type</span><span class="p">,</span> <span class="n">cursor_position</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;ND2s use various codes to indicate different data types, which we translate here.</span>
 
+<span class="sd">    Args:</span>
+<span class="sd">        data:</span>
+<span class="sd">        data_type:</span>
+<span class="sd">        cursor_position:</span>
+
+<span class="sd">    Returns:</span>
+
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">parser</span> <span class="o">=</span> <span class="p">{</span><span class="mi">1</span><span class="p">:</span> <span class="n">_parse_unsigned_char</span><span class="p">,</span>
               <span class="mi">2</span><span class="p">:</span> <span class="n">_parse_unsigned_int</span><span class="p">,</span>
@@ -212,7 +235,14 @@ <h1>Source code for nd2reader.common</h1><div class="highlight"><pre>
 
 
 <div class="viewcode-block" id="read_metadata"><a class="viewcode-back" href="../../nd2reader.html#nd2reader.common.read_metadata">[docs]</a><span class="k">def</span> <span class="nf">read_metadata</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">count</span><span class="p">):</span>
-    <span class="sd">&quot;&quot;&quot;Iterates over each element some section of the metadata and parses it.</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Iterates over each element some section of the metadata and parses it.</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        data:</span>
+<span class="sd">        count:</span>
+
+<span class="sd">    Returns:</span>
 
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
@@ -242,7 +272,16 @@ <h1>Source code for nd2reader.common</h1><div class="highlight"><pre>
 
 
 <span class="k">def</span> <span class="nf">_add_to_metadata</span><span class="p">(</span><span class="n">metadata</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
-    <span class="sd">&quot;&quot;&quot;Add the name value pair to the metadata dict</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Add the name value pair to the metadata dict</span>
+
+<span class="sd">    Args:</span>
+<span class="sd">        metadata:</span>
+<span class="sd">        name:</span>
+<span class="sd">        value:</span>
+
+<span class="sd">    Returns:</span>
+
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">if</span> <span class="n">name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">metadata</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span>
         <span class="n">metadata</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>