Skip to content

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"
/>
deprecatedoptionalstring
descriptionChildren[]
examplesoptionalChildren[]
noteoptionalstring
parametersoptionalParameterDescriptor[]
raisesoptionalstring[]
seeAlsooptionalstring[]
styleoptional”google”
warningoptionalstring
yieldsoptionalstring