module documentation
Class ModuleVisitor No class docstring; 2/2 methods documented
Function deprecatedToUsefulText Change a @deprecated to a display string.
Function getDeprecated With a list of decorators, and the object it is running on, set the _deprecated_info flag if any of the decorators are a Twisted deprecation decorator.
Function setup_pydoctor_extension Undocumented
Function versionToUsefulObject Change an AST Version() to a real one.
Variable _deprecated_signature Undocumented
Variable _deprecation_text_with_replacement_template Undocumented
Variable _deprecation_text_without_replacement_template Undocumented
Variable _incremental_Version_signature Undocumented
def deprecatedToUsefulText(ctx: model.Documentable, name: str, deprecated: ast.Call) -> tuple[str, str]: (source)

Change a @deprecated to a display string.

Parameters
ctx:model.DocumentableThe context in which the deprecation is evaluated.
name:strThe name of the thing we're deprecating.
deprecated:ast.CallAST call to twisted.python.deprecate.deprecated or twisted.python.deprecate.deprecatedProperty.
Returns
tuple[str, str]The version and text to use in the deprecation warning.
Raises
ValueError or TypeErrorIf something is wrong.
def getDeprecated(self: model.Documentable, decorators: Sequence[ast.expr]): (source)

With a list of decorators, and the object it is running on, set the _deprecated_info flag if any of the decorators are a Twisted deprecation decorator.

def setup_pydoctor_extension(r: extensions.ExtRegistrar): (source)

Undocumented

def versionToUsefulObject(version: ast.Call) -> incremental.Version: (source)

Change an AST Version() to a real one.

Raises
ValueErrorIf the incremental.Version call is invalid.
Note
Only use required arguments, ignores arguments release_candidate, prerelease, post, dev.
_deprecated_signature = (source)

Undocumented

_deprecation_text_with_replacement_template: str = (source)

Undocumented

_deprecation_text_without_replacement_template: str = (source)

Undocumented

_incremental_Version_signature = (source)

Undocumented