Method doc_option

awscli/clidocs.py:181–221

(self, arg_name, help_command, **kwargs)

            doc.write('*None*\n')

    def doc_option(self, arg_name, help_command, **kwargs):
        doc = help_command.doc
        argument = help_command.arg_table[arg_name]
        if argument.required or getattr(
            argument, '_DOCUMENT_AS_REQUIRED', False
        ):
            required_field = ' [required]'
        else:
            required_field = ''

        if argument.group_name in self._arg_groups:
            if argument.group_name in self._documented_arg_groups:
                # This arg is already documented so we can move on.
                return
            name = ' | '.join(
                [
                    f'``{a.cli_name}``'
                    for a in self._arg_groups[argument.group_name]
                ]
            )
            self._documented_arg_groups.append(argument.group_name)
        else:
            name = f'``{argument.cli_name}``'
        doc.write(
            f'{name} '
            f'({self._get_argument_type_name(argument.argument_model, argument.cli_type_name)})'
            f'{required_field}\n'
        )

        doc.style.indent()
        doc.include_doc_string(argument.documentation)
        if is_streaming_blob_type(argument.argument_model):
            self._add_streaming_blob_note(doc)
        if is_tagged_union_type(argument.argument_model):
            self._add_tagged_union_note(argument.argument_model, doc)
        if hasattr(argument, 'argument_model'):
            self._document_enums(argument.argument_model, doc)
            self._document_constraints(argument.argument_model, doc)
            self._document_nested_structure(argument.argument_model, doc)
        doc.style.dedent()
        doc.style.new_paragraph()

    def doc_global_option(self, help_command, **kwargs):
        doc = help_command.doc