Module « pydoc » Python 3.11.3

Classe « TextDoc »

Informations générales

builtins.object
    Doc
        TextDoc

class TextDoc(Doc):

Formatter class for text documentation.

Signature du constructeur	Description
__init__(self, /, args, *kwargs)	Initialize self. See help(type(self)) for accurate signature. _{[extrait de __init__.__doc__]}

Nom de l'attribut	Valeur
PYTHONDOCS	https://docs.python.org/3.11/library

Toutes les méthodes Méthodes d'instance Méthodes statiques

Signature de la méthode	Description
bold(self, text)	Format a string in bold by overstriking. _{[extrait de bold.__doc__]}
docclass(self, object, name=None, mod=None, *ignored)	Produce text documentation for a given class object. _{[extrait de docclass.__doc__]}
docdata(self, object, name=None, mod=None, cl=None)	Produce text documentation for a data descriptor. _{[extrait de docdata.__doc__]}
docmodule(self, object, name=None, mod=None)	Produce text documentation for a given module object. _{[extrait de docmodule.__doc__]}
docother(self, object, name=None, mod=None, parent=None, maxlen=None, doc=None)	Produce text documentation for a data object. _{[extrait de docother.__doc__]}
docproperty(self, object, name=None, mod=None, cl=None)	Produce text documentation for a data descriptor. _{[extrait de docdata.__doc__]}
docroutine(self, object, name=None, mod=None, cl=None)	Produce text documentation for a function or method object. _{[extrait de docroutine.__doc__]}
formattree(self, tree, modname, parent=None, prefix='')	Render in text a class tree as returned by inspect.getclasstree(). _{[extrait de formattree.__doc__]}
formatvalue(self, object)	Format an argument default value as text. _{[extrait de formatvalue.__doc__]}
indent(self, text, prefix=' ')	Indent text by prepending a given prefix to each line. _{[extrait de indent.__doc__]}
section(self, title, contents)	Format a section with a given heading. _{[extrait de section.__doc__]}