Skip to content

Change median and mean export, or update documentation #146

@milesfrain

Description

@milesfrain

There's a mismatch between what the documentation suggests and how these functions are exported.

maximum and minimum are exported to Base, while median and mean are exported to Statistics.

Base.minimum(group::BenchmarkGroup) = mapvals(minimum, group)
Base.maximum(group::BenchmarkGroup) = mapvals(maximum, group)
Statistics.mean(group::BenchmarkGroup) = mapvals(mean, group)
Statistics.median(group::BenchmarkGroup) = mapvals(median, group)

The manual does not mention the need for using Statistics to get the the remaining two functions to work.

The reference guide also suggests that median and mean are exported the same as minimum and maximum.

Unsure whether median and mean should be exported to Base, since this wouldn't extending an existing Base method.

Similar to #143

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions