tags ¤

Bases: TextTag

A tag representing an author.

Attributes:

• text (str) –

  The tag's text.

Bases: TextTag

A tag representing a summary.

Attributes:

• text (str) –

  The tag's text.

Bases: TextTag

A tag representing a bug note.

Attributes:

• text (str) –

  The tag's text.

Bases: TextTag

A tag representing caveats.

Attributes:

• text (str) –

  The tag's text.

Bases: TextTag

A tag representing copyright information.

Attributes:

• text (str) –

  The tag's text.

Bases: TextTag

A tag representing a date.

Attributes:

• text (str) –

  The tag's text.

Bases: TextTag

A tag representing a description.

Attributes:

• text (str) –

  The tag's text.

Bases: NameDescTag

A tag representing an environment variable used by the script.

Attributes:

• description (str) –

  The tag description.

• name (str) –

  The tag name.

Bases: TextTag

A tag representing a known error.

Attributes:

• text (str) –

  The tag's text.

Bases: Tag

A tag representing a code/shell example.

Attributes:

• brief (str) –

  The example's summary.

• code (str) –

  The example's code.

• code_lang (str) –

  The example's language.

• description (str) –

  The example's description.

brief: str

code: str

code_lang: str

description: str

Bases: Tag

A tag representing an exit code.

Attributes:

• code (str) –

  The exit code.

• description (str) –

  The code description.

code: str

description: str

Bases: NameDescTag

A tag representing a file used by a script.

Attributes:

• description (str) –

  The tag description.

• name (str) –

  The tag name.

Bases: Tag

A tag representing a shell function.

Attributes:

• arguments (Sequence[str]) –

  The function's arguments.

• brief (str) –

  The function's summary.

• description (str) –

  The function's description.

• preconditions (Sequence[str]) –

  The function's preconditions.

• prototype (str) –

  The function's prototype.

• return_codes (Sequence[str]) –

  The function's return codes.

• seealso (Sequence[str]) –

  The function's "see also" information.

• stderr (Sequence[str]) –

  The function's standard error.

• stdin (Sequence[str]) –

  The function's standard input.

• stdout (Sequence[str]) –

  The function's standard output.

arguments: Sequence[str]

brief: str

description: str

preconditions: Sequence[str]

prototype: str

return_codes: Sequence[str]

seealso: Sequence[str]

stderr: Sequence[str]

stdin: Sequence[str]

stdout: Sequence[str]

Bases: TextTag

A tag representing a script's history.

Attributes:

• text (str) –

  The tag's text.

Bases: TextTag

A tag representing a license.

Attributes:

• text (str) –

  The tag's text.

Bases: Tag

A tag holding a name and a description.

Attributes:

• description (str) –

  The tag description.

• name (str) –

  The tag name.

description: str

name: str

Bases: TextTag

A tag representing a note.

Attributes:

• text (str) –

  The tag's text.

Bases: Tag

A tag representing a command-line option.

Attributes:

• default (str) –

  The option default value.

• description (str) –

  The option description.

• group (str) –

  The option group.

• long (str) –

  The option long flag.

• positional (str) –

  The option positional arguments.

• short (str) –

  The option short flag.

• signature (str) –

  The signature of the option.

default: str

description: str

group: str

long: str

positional: str

short: str

signature: str

Bases: TextTag

A tag representing "See Also" information.

Attributes:

• text (str) –

  The tag's text.

Bases: TextTag

A tag representing the standard error of a script/function.

Attributes:

• text (str) –

  The tag's text.

Bases: TextTag

A tag representing the standard input of a script/function.

Attributes:

• text (str) –

  The tag's text.

Bases: TextTag

A tag representing the standard output of a script/function.

Attributes:

• text (str) –

  The tag's text.

Base class for tags.

Methods:

• from_lines –

  Parse a sequence of lines into a tag instance.

from_lines(lines: Sequence[DocLine]) -> Tag

20
21
22
23
24
25
26
27
28
29
30

@classmethod
def from_lines(cls, lines: Sequence[DocLine]) -> Tag:
    """Parse a sequence of lines into a tag instance.

    Parameters:
        lines: The sequence of lines to parse.

    Returns:
        A tag instance.
    """
    raise NotImplementedError

Bases: Tag

A simple tag holding text only.

Attributes:

• text (str) –

  The tag's text.

text: str

Bases: Tag

A tag representing the command-line usage of a script.

Attributes:

• command (str) –

  The command-line usage.

• program (str) –

  The program name.

command: str

program: str

Bases: TextTag

A tag representing a version.

Attributes:

• text (str) –

  The tag's text.