Logo Search packages:      
Sourcecode: matplotlib version File versions

def enthought::traits::traits::CTrait::get_help (   self,
  full = True 
)

Returns the help text for a trait.

Parameters
----------
full : Boolean
    Indicates whether to return the value of the *help* attribute of
    the trait itself.

Description
-----------
If *full* is False or the trait does not have a **help** string,
the returned string is constructed from the **desc** attribute on the
trait and the **info** string on the trait's handler.

Definition at line 204 of file traits.py.

00204                                       :
        """ Returns the help text for a trait.

        Parameters
        ----------
        full : Boolean
            Indicates whether to return the value of the *help* attribute of
            the trait itself.

        Description
        -----------
        If *full* is False or the trait does not have a **help** string,
        the returned string is constructed from the **desc** attribute on the
        trait and the **info** string on the trait's handler.
        """
        if full:
            help = self.help
            if help is not None:
                return help
        handler = self.handler
        if handler is not None:
            info = 'must be %s.' % handler.info()
        else:
            info = 'may be any value.'
        desc = self.desc
        if self.desc is None:
            return info.capitalize()
        return 'Specifies %s and %s' % ( desc, info )

    #---------------------------------------------------------------------------
    #  Returns the pickleable form of a CTrait object:
    #---------------------------------------------------------------------------

    def __reduce_ex__ ( self, protocol ):


Generated by  Doxygen 1.6.0   Back to index