avitex
/
glicko-elixir
mirror of https://github.com/avitex/elixir-glicko
1
0
Fork 0
Code Issues Releases Wiki Activity

Improve result docs

This commit is contained in:
avitex 2017-11-29 12:53:31 +11:00
parent 0ebfbe6447
commit 0f013beaa3
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/glicko/result.ex
View File

@ -1,6 +1,6 @@
defmodule Glicko.Result do defmodule Glicko.Result do
@moduledoc """ @moduledoc """
Convenience functions for handling a result against an opponent. Provides convenience functions for handling a result against an opponent.
## Usage ## Usage
@ -25,6 +25,8 @@ defmodule Glicko.Result do
@doc """ @doc """
Creates a new result from an opponent rating, opponent rating deviation and score. 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. Supports passing either `:loss`, `:draw`, or `:win` as shortcuts.
""" """
@spec new(Player.rating, Player.rating_deviation, score | score_shortcut) :: t @spec new(Player.rating, Player.rating_deviation, score | score_shortcut) :: t