Method func_doc

sdk/python/codegen/src/codegen/generator.py:822–882

(self)

        return name

    def func_doc(self) -> str:
        def _out():
            if self.description:
                yield (textwrap.fill(line) for line in self.description.splitlines())

            if deprecated := self.deprecated(":py:meth:`", "`"):
                yield chain(
                    (".. deprecated::",),
                    wrap_indent(deprecated),
                )
            if experimental := self.experimental(":py:meth:`", "`"):
                yield chain(
                    (".. caution::",),
                    wrap_indent("Experimental: " + experimental),
                )

            if self.name == "id":
                yield (
                    "Note",
                    "----",
                    "This is lazily evaluated, no operation is actually run.",
                )

            if any(arg.description or arg.deprecated is not None for arg in self.args):
                yield chain(
                    (
                        "Parameters",
                        "----------",
                    ),
                    (arg.as_doc() for arg in self.args),
                )

            if self.is_leaf:
                return_doc = output_type_description(self.graphql.type)
                if not self.convert_id and return_doc:
                    yield chain(
                        (
                            "Returns",
                            "-------",
                            self.type,
                        ),
                        wrap_indent(return_doc),
                    )

                yield chain(
                    (
                        "Raises",
                        "------",
                        "ExecuteTimeoutError",
                    ),
                    wrap_indent(
                        "If the time to execute the query exceeds the "
                        "configured timeout."
                    ),
                    (
                        "QueryError",
                        indent("If the API returns an error."),
                    ),