Highlight important ideas or signal content that’s supplemental or only relevant in certain situations.

Properties

The Admonition type has these properties:

Name	Description	Type	Inherited from
`id`	The identifier for this item.	`String`	`Entity`
`admonitionType`	The type of admonition.	`AdmonitionType`	-
`title`	The title of the admonition.	`Inline`*	-
`isFolded`	Whether the admonition is folded.	`Boolean`	-
`content`	The content within the section.	`Block`*	-
`authors`	The authors of the admonition.	`Author`*	-
`provenance`	A summary of the provenance of the content within the admonition.	`ProvenanceCount`*	-

The Admonition type is related to these types:

Parents: Entity

Children: none

Bindings

The Admonition type is represented in:

Python class Admonition

TypeScript class Admonition

During property-based (a.k.a generative) testing, the properties of the Admonition type are generated using the following strategies.

Property	Complexity	Description	Strategy
`admonitionType`	Min+	Fixed admonition type.	`AdmonitionType::Info`
	Low+	Generate an arbitrary admonition type.	`AdmonitionType::arbitrary()`
`title`	Min+	No title.	`None`
	Low+	Generate up to two arbitrary, non-recursive, inline nodes.	`option::of(vec_inlines_non_recursive(2))`
	High+	Generate up to four arbitrary, non-recursive, inline nodes.	`option::of(vec_inlines_non_recursive(4))`
`isFolded`	Min+	Not foldable.	`None`
	Low+	Arbitrarily, un-foldable, folded, or unfolded.	`option::of(bool::arbitrary())`
`content`	Min+	A single, simple paragraph.	`vec![p([t("Admonition content")])]`
	Low+	Generate up to two arbitrary paragraphs.	`vec_paragraphs(2)`
	High+	Generate up to four arbitrary, non-recursive, block nodes.	`vec_blocks_non_recursive(4)`

This documentation was generated from Admonition.yaml by docs_types.rs.