Ignore:
Timestamp:
Dec 8, 2015 6:02:57 PM (6 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/source/imports.rst

    r2068 r2087  
    6060    method when ``strictExtension`` is False.
    6161  * ``formatName``: a string to be used in the menu. Should be short.
    62   * ``longFormatName``: a longer string to be used to describe the format in help.
     62  * ``longFormatName``: a longer string to be used to describe the
     63    format in help.
     64
     65Note that if an importer detects a condition which prevents its use,
     66for example because a required Python package is not present, it can
     67set the value of ``self.UseReader`` to False. Another possible use for
     68this would be an importer that requires a network connection to a
     69remote site. Setting ``self.UseReader`` to False must be done in the
     70``__init__`` method and will prevent the
     71importer from being used or included in the expected menu.
    6372
    6473Reader()
Note: See TracChangeset for help on using the changeset viewer.