deploy: c827af8

Author: zbjornson

fcs_files/index.html

@@ -1103,7 +1103,7 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.channels" class="doc doc-heading">
 
   <div class="doc doc-contents ">
 
-      <p>Return all channels in the file</p>
+      <p>Return all channels in the file.</p>
   </div>
 
 </div>
@@ -1124,6 +1124,9 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.compensation" class="doc doc-headi
 
 
   <div class="doc doc-contents ">
+  
+      <p>Used with per-file compensation to indicate the compensation to apply
+to this file.</p>
   </div>
 
 </div>
@@ -1144,6 +1147,8 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.crc32c" class="doc doc-heading">
 
 
   <div class="doc doc-contents ">
+  
+      <p>The CRC32c sum for the file, hex-encoded, per RFC 4960 Appendix B.</p>
   </div>
 
 </div>
@@ -1185,6 +1190,9 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.deleted" class="doc doc-heading">
 
 
   <div class="doc doc-contents ">
+  
+      <p>If set, the file has been soft-deleted and may be permanently deleted
+later.</p>
   </div>
 
 </div>
@@ -1205,6 +1213,8 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.event_count" class="doc doc-headin
 
 
   <div class="doc doc-contents ">
+  
+      <p>The number of events (rows) in the file.</p>
   </div>
 
 </div>
@@ -1273,6 +1283,8 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.filename" class="doc doc-heading">
 
 
   <div class="doc doc-contents ">
+  
+      <p>The filename.</p>
   </div>
 
 </div>
@@ -1294,6 +1306,8 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.gates_locked" class="doc doc-headi
 
 
   <div class="doc doc-contents ">
+  
+      <p>If true, no gates that apply to this file can be changed.</p>
   </div>
 
 </div>
@@ -1314,6 +1328,9 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.has_file_internal_comp" class="doc
 
 
   <div class="doc doc-contents ">
+  
+      <p>Whether or not this file has a valid file-internal compensation
+matrix.</p>
   </div>
 
 </div>
@@ -1378,6 +1395,10 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.is_control" class="doc doc-heading
 
 
   <div class="doc doc-contents ">
+  
+      <p>Whether or not this is a control file. Control files are hidden from
+most of the Web UI, and can be used to exclude compensation or
+calibration beads from analysis, for example.</p>
   </div>
 
 </div>
@@ -1398,6 +1419,8 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.md5" class="doc doc-heading">
 
 
   <div class="doc doc-contents ">
+  
+      <p>The MD5 sum for the file, hex-encoded.</p>
   </div>
 
 </div>
@@ -1461,6 +1484,9 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.panel_name" class="doc doc-heading
 
 
   <div class="doc doc-contents ">
+  
+      <p>The name of the file's panel. Files with the same panelName are
+grouped into a panel.</p>
   </div>
 
 </div>
@@ -1481,6 +1507,8 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.sample_name" class="doc doc-headin
 
 
   <div class="doc doc-contents ">
+  
+      <p>The sample name extracted from the file header.</p>
   </div>
 
 </div>
@@ -1501,6 +1529,8 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.size" class="doc doc-heading">
 
 
   <div class="doc doc-contents ">
+  
+      <p>The number of bytes in the file.</p>
   </div>
 
 </div>
@@ -1522,7 +1552,9 @@ <h3 id="cellengine.resources.fcs_file.FcsFile.spill_string" class="doc doc-headi
 
   <div class="doc doc-contents ">
 
-      <p>Note: this property may be fetched lazily.</p>
+      <p>The file-internal compensation, if present (see
+<code>has_file_internal_comp</code>). Note: this property may be fetched lazily due
+to its size.</p>
   </div>
 
 </div>

folders/index.html

@@ -783,6 +783,8 @@ <h3 id="cellengine.resources.folder.Folder.created" class="doc doc-heading">
 
 
   <div class="doc doc-contents ">
+  
+      <p>The date on which the folder was created.</p>
   </div>
 
 </div>
@@ -824,6 +826,8 @@ <h3 id="cellengine.resources.folder.Folder.deleted" class="doc doc-heading">
 
 
   <div class="doc doc-contents ">
+  
+      <p>If the folder is soft-deleted, the date on which it was soft-deleted.</p>
   </div>
 
 </div>
@@ -888,6 +892,8 @@ <h3 id="cellengine.resources.folder.Folder.path" class="doc doc-heading">
 
 
   <div class="doc doc-contents ">
+  
+      <p>The list of IDs of parent folders.</p>
   </div>
 
 </div>
@@ -932,7 +938,7 @@ <h3 id="cellengine.resources.folder.Folder.create" class="doc doc-heading">
 
   <div class="doc doc-contents ">
 
-      <p>Create a folder.</p>
+      <p>Creates a folder.</p>
 
 
 
@@ -1047,7 +1053,7 @@ <h3 id="cellengine.resources.folder.Folder.get" class="doc doc-heading">
 
   <div class="doc doc-contents ">
 
-      <p>Get a Folder name or ID. Either <code>name</code> or <code>_id</code> must be specified.</p>
+      <p>Get a Folder by name or ID. Either <code>name</code> or <code>_id</code> must be specified.</p>