def py__doc__(self, include_signatures=False):
        if self.api_type in ('function', 'class'):
            return clean_scope_docstring(self.tree_name.get_definition())

        if self.api_type == 'statement' and self.tree_name.is_definition():
            return find_statement_documentation(
                self.tree_name.get_definition())

        if self.api_type == 'module':
            names = self.goto()
            if self not in names:
                return _merge_name_docs(names)
        return super(TreeNameDefinition, self).py__doc__(include_signatures)
Exemple #2
0
    def py__doc__(self):
        api_type = self.api_type
        if api_type in ('function', 'class'):
            # Make sure the names are not TreeNameDefinitions anymore.
            return clean_scope_docstring(self.tree_name.get_definition())

        if api_type == 'module':
            names = self.goto()
            if self not in names:
                return _merge_name_docs(names)

        if api_type == 'statement' and self.tree_name.is_definition():
            return find_statement_documentation(self.tree_name.get_definition())
        return ''
    def py__doc__(self):
        api_type = self.api_type
        if api_type in ('function', 'class', 'property'):
            if self.parent_context.get_root_context().is_stub():
                from jedi.inference.gradual.conversion import convert_names
                names = convert_names([self], prefer_stub_to_compiled=False)
                if self not in names:
                    return _merge_name_docs(names)

            # Make sure the names are not TreeNameDefinitions anymore.
            return clean_scope_docstring(self.tree_name.get_definition())

        if api_type == 'module':
            names = self.goto()
            if self not in names:
                return _merge_name_docs(names)

        if api_type == 'statement' and self.tree_name.is_definition():
            return find_statement_documentation(self.tree_name.get_definition())
        return ''