How do I get rid off 'Describe the parameter "map".' ?

[PragTob]

Not sure what inch_ex wants me to do, I tried a couple of things and was not available to get rid off that warning/suggestion. A help with how to fix suggestions per language would be very helpful.

project: http://inch-ci.org/github/PragTob/benchee

inch_ci report:

Benchee.Statistics.statistics/1
Parsed documentation:
View on GitHub

Takes a job suite with job run times, returns a map representing the
statistics of the job suite as follows:

  * average       - average run time of the job in μs (the lower the better)
  * ips           - iterations per second, how often can the given function be
    executed within one second (the higher the better)
  * std_dev       - standard deviation, a measurement how much results vary
    (the higher the more the results vary)
  * std_dev_ratio - standard deviation expressed as how much it is relative to
    the average
  * std_dev_ips   - the absolute standard deviation of iterations per second
    (= ips * std_dev_ratio)
  * median        - when all measured times are sorted, this is the middle
    value (or average of the two middle values when the number of times is
    even). More stable than the average and somewhat more likely to be a
    typical you see.

## Parameters

* `suite` - the job suite represented as a map after running the measurements,
  required to have the run_times available under the `run_times` key

## Examples

    iex> run_times = [200, 400, 400, 400, 500, 500, 700, 900]
    iex> suite = %{run_times: [{"My Job", run_times}]}
    iex> Benchee.Statistics.statistics(suite)
    [{"My Job",
      %{average:       500.0,
        ips:           2000.0,
        std_dev:       200.0,
        std_dev_ratio: 0.4,
        std_dev_ips:   800.0,
        median:        450.0}}]

Suggestions:

    Describe the parameter "map".

method:

  def statistics(%{run_times: run_times}) do
    Enum.map run_times, fn({name, job_run_times}) ->
      {name, Statistics.job_statistics(job_run_times)}
    end
  end

Thanks + cheers, Tobi

[rrrene]

Oh, that's a bug! Thx for reporting! :+1: