GeneratorDoc
A component that creates a GeneratorDoc block for generator functions.
import { GeneratorDoc } from "@alloy-js/python";
<GeneratorDoc deprecated="string" description={Children[]} examples={Children[]} note="string" parameters={ParameterDescriptor[]} raises={string[]} seeAlso={string[]} style={"google"} warning="string" yields="string" />
import { GeneratorDoc } from "@alloy-js/python/stc";
GeneratorDoc({ deprecated: string, description: Children[], examples: Children[], note: string, parameters: ParameterDescriptor[], raises: string[], seeAlso: string[], style: "google", warning: string, yields: string,}).children(children)
deprecated | optionalstring |
description | Children[] |
examples | optionalChildren[] |
note | optionalstring |
parameters | optionalParameterDescriptor[] |
raises | optionalstring[] |
seeAlso | optionalstring[] |
style | optional”google” |
warning | optionalstring |
yields | optionalstring |