We have an existing example_density signal that measure the presence of examples across elements that supports examples. It would be beneficial to have a signal called example_richness to measure depth (e.g. how good and how complete examples are).
Description:
Evaluates how richly examples illustrate behaviour across the API, factoring both density and breadth of schema examples.
Calculation:
example_richness = min(1,
0.5 * avg_examples_per_location
+ 0.5 * schema_example_coverage
)
Where:
avg_examples_per_location = total_examples_defined / example_locations_with_any_example
# capped at 2.0
# normalised to [0,1] using value/2
schema_example_coverage = = schemas_with_examples / total_schemas
We have an existing
example_densitysignal that measure the presence of examples across elements that supports examples. It would be beneficial to have a signal calledexample_richnessto measure depth (e.g. how good and how complete examples are).Description:
Evaluates how richly examples illustrate behaviour across the API, factoring both density and breadth of schema examples.
Calculation:
Where: