From f85e3db06769500dea9fc99e0ddc52aec6a8ef90 Mon Sep 17 00:00:00 2001 From: Tobias Pfeiffer Date: Thu, 28 Mar 2019 15:21:40 +0100 Subject: [PATCH] ugh there was documentation missing :scream: --- lib/benchee/formatters/tagged_save.ex | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/benchee/formatters/tagged_save.ex b/lib/benchee/formatters/tagged_save.ex index c8963a82..749113d8 100644 --- a/lib/benchee/formatters/tagged_save.ex +++ b/lib/benchee/formatters/tagged_save.ex @@ -14,6 +14,9 @@ defmodule Benchee.Formatters.TaggedSave do alias Benchee.Suite alias Benchee.Utility.FileCreation + @doc """ + Tags all scenario with the desired tag and returns it in term_to_binary along with save path. + """ @impl true @spec format(Suite.t(), map) :: {binary, String.t()} def format(suite = %Suite{scenarios: scenarios}, formatter_config) do @@ -71,6 +74,9 @@ defmodule Benchee.Formatters.TaggedSave do %Scenario{scenario | name: Scenario.display_name(scenario)} end + @doc """ + Writes the binary returned by `format/2` to the indicated location, telling you where that is. + """ @spec write({binary, String.t()}, map) :: :ok @impl true def write({term_binary, filename}, _) do