finesse.script.generator.KatSyntaxUnparser.syntax

KatSyntaxUnparser.syntax(directive, optional_as_positional=False)

Get syntax for directive.

Parameters

directive : str

The directive to generate syntax for.

optional_as_positional : bool, optional

Show optional parameters in positional form rather than keyword form. Defaults to False.

Returns

str

The syntax for directive.

Raises

ValueError

If directive is not recognised as a valid KatScript directive in spec.