Raw (pass-through) docstring converter.
This is most useful for internal calls in a formatter. For
instance, if a formatter calls self.writeText() and passes text
that it has produced, it can use "RawText" as the textFormat
argument.
This converter is not recommended for most uses.
|
Base Classes
|
|
happydoclib.happydocstring.HappyDocStringConverterBase
|
|
Methods
|
|
convert
quote
|
|
|
convert
|
convert (
self,
inputText,
outputFormat,
*args,
*namedArgs,
)
Returns the inputText data translated into the outputFormat.
Parameters:
-
inputText
- String or other sequence of characters to be
converted. This string should be in the format advertised
by the docstring converter.
-
outputFormat
- String defined by the docstring converter
class to represent a supported output scheme. This value is
converter-specific, and not all converters will support the
same output formats.
|
|
|
quote
|
quote (
self,
inputText,
outputFormat,
*args,
*namedArgs,
)
Returns the inputText quoted in a way that special characters are escaped.
Parameters:
-
inputText
- String or other sequence of characters to be
converted. This string should be in the format advertised
by the docstring converter.
-
outputFormat
- String defined by the docstring converter
class to represent a supported output scheme. This value is
converter-specific, and not all converters will support the
same output formats.
-
*args
- Additional, converter-specific, positional arguments.
-
**namedArgs
- Additional, converter-specific, named arguments.
|
|