Functions

List of functions in the ude.parsers.dialects.base namespace.

Entity Name	Description
_clean_xrefs	Replaces :domain:role:`target` cross-references with bare target text.
_clean_xrefs_in_dict
_empty_parse

Directory & Entity Index

Entity Name Summary / Description

Replaces :domain:role:target cross-references with bare target text.

_clean_xrefs(text: str) -> str

Replaces :domain:role:target cross-references with bare target text.

Returns:

The text with cross-reference markup removed.

Parameter	Type	Description
text	`str`	The text to clean.

Returns a copy of d with xrefs cleaned from all string values.

_clean_xrefs_in_dict(d: dict) -> dict

Returns a copy of d with xrefs cleaned from all string values.

Returns:

A new dict with the same keys and cross-reference-cleaned string values.

Parameter	Type	Description
d	`dict`	A dict whose string values may contain cross-reference markup.

Returns a zero-content DocstringParse sentinel. DocstringParse` with all fields at their defaults.

_empty_parse() -> DocstringParse

Returns a zero-content DocstringParse sentinel. DocstringParse` with all fields at their defaults.

Returns:

A `