From 0f013beaa332d6994f25a44ebf501fec8088b229 Mon Sep 17 00:00:00 2001 From: avitex Date: Wed, 29 Nov 2017 12:53:31 +1100 Subject: [PATCH] Improve result docs --- lib/glicko/result.ex | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lib/glicko/result.ex b/lib/glicko/result.ex index 390f85e..f66418a 100644 --- a/lib/glicko/result.ex +++ b/lib/glicko/result.ex @@ -1,6 +1,6 @@ defmodule Glicko.Result do @moduledoc """ - Convenience functions for handling a result against an opponent. + Provides convenience functions for handling a result against an opponent. ## Usage @@ -25,6 +25,8 @@ defmodule Glicko.Result do @doc """ Creates a new result from an opponent rating, opponent rating deviation and score. + Values provided for the opponent rating and opponent rating deviation must be *v2* based. + Supports passing either `:loss`, `:draw`, or `:win` as shortcuts. """ @spec new(Player.rating, Player.rating_deviation, score | score_shortcut) :: t