Skip to main content

description

Function description 

fn description(
    entry: &PublicEntry,
    variable: &Variable,
) -> Result<Vec<String>, Error>
Expand description

A variable’s description, from the code where the code has one.

§Errors

Error::Unclassifiable when there is no description, and — the other half of the same rule — when there are two. A summary in the allow-list beside a documented constant is exactly the second copy that goes stale, so it is refused rather than preferred.