Method format_description

samcli/commands/docs/core/command.py:39–57

Formats the description of the help text for the docs command. Parameters ---------- formatter: DocsCommandHelpTextFormatter A formatter instance to use for formatting the help text

(formatter: DocsCommandHelpTextFormatter)

    @staticmethod
    def format_description(formatter: DocsCommandHelpTextFormatter):
        """
        Formats the description of the help text for the docs command.

        Parameters
        ----------
        formatter: DocsCommandHelpTextFormatter
            A formatter instance to use for formatting the help text
        """
        with formatter.indented_section(name="Description", extra_indents=1):
            formatter.write_text_rows(
                [
                    RowDefinition(
                        text="",
                        name=DESCRIPTION
                        + style(f"{os.linesep}  This command does not require access to AWS credentials.", bold=True),
                    ),
                ],
            )

    def format_sub_commands(self, formatter: DocsCommandHelpTextFormatter):
        """