FunctionDoc

A component that creates a FunctionDoc block for parameters.

jsx

import { FunctionDoc } from "@alloy-js/python";

<FunctionDoc
  description={Children[]}
  parameters={ParameterDescriptor[] | string[]}
  raises={string[]}
  returns="string"
  style={"google"}
 />

stc

import { FunctionDoc } from "@alloy-js/python/stc";

FunctionDoc({
  description: Children[],
  parameters: ParameterDescriptor[] | string[],
  raises: string[],
  returns: string,
  style: "google",
}).children(children)

Props

description	Children[]
parameters	optionalParameterDescriptor[] | string[]
raises	optionalstring[]
returns	optionalstring
style	optional”google”