extract_yearn_short_description

Documentation for eth_defi.erc_4626.vault_protocol.yearn.offchain_metadata.extract_yearn_short_description function.

extract_yearn_short_description(description)

Extract a bounded first sentence from a Yearn description.

Yearn descriptions are free-form Markdown and do not consistently use a full stop followed by a space. A punctuation-aware split handles links and newline-separated sentences, while a length limit prevents a malformed or sentence-less source value from filling the website listing.

Parameters

description (Optional[str]) – Full description from Yearn’s detected-vault endpoint.

Returns

First sentence when it fits the compact listing field, otherwise None.

Return type

Optional[str]