Changeset 2087 for trunk/docs/source/imports.rst

Timestamp:

Dec 8, 2015 6:02:57 PM (8 years ago)

Author:

toby

Message:

change error handling if h5py not installed; add new condition variable to importers (self.UseReader?); changes to docs to reflect this and consolidate description of package requirements

File:

• trunk/docs/source/imports.rst (modified) (1 diff)

trunk/docs/source/imports.rst

@@ -60 +60 @@
     method when ``strictExtension`` is False.
   * ``formatName``: a string to be used in the menu. Should be short. 
-  * ``longFormatName``: a longer string to be used to describe the format in help. 
+  * ``longFormatName``: a longer string to be used to describe the
+    format in help. 
+
+Note that if an importer detects a condition which prevents its use,
+for example because a required Python package is not present, it can
+set the value of ``self.UseReader`` to False. Another possible use for
+this would be an importer that requires a network connection to a
+remote site. Setting ``self.UseReader`` to False must be done in the 
+``__init__`` method and will prevent the
+importer from being used or included in the expected menu. 
 
 Reader()