FunctionDoc

A component that creates a FunctionDoc block for functions.

jsx

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

<FunctionDoc
  deprecated="string"
  description={Children[]}
  examples={Children[]}
  note="string"
  parameters={ParameterDescriptor[]}
  raises={string[]}
  returns="string"
  seeAlso={string[]}
  style={"google"}
  warning="string"
  yields="string"
 />

stc

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

FunctionDoc({
  deprecated: string,
  description: Children[],
  examples: Children[],
  note: string,
  parameters: ParameterDescriptor[],
  raises: string[],
  returns: string,
  seeAlso: string[],
  style: "google",
  warning: string,
  yields: string,
}).children(children)

Props

deprecated	optional string
description	Children[]
examples	optional Children[]
note	optional string
parameters	optional ParameterDescriptor[]
raises	optional string[]
returns	optional string
seeAlso	optional string[]
style	optional “google”
warning	optional string
yields	optional string