Current section
29 Versions
Jump to
Current section
29 Versions
Compare versions
4
files changed
+10
additions
-4
deletions
| @@ -1,6 +1,6 @@ | |
| 1 1 | # Islands Player ID |
| 2 2 | |
| 3 | - Defines the `player ID` type for the _Game of Islands_. |
| 3 | + Defines the [`player ID`][player_id] type for the [Game of Islands][readme]. |
| 4 4 | |
| 5 5 | ## Installation |
| 6 6 | |
| @@ -19,3 +19,5 @@ Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_do | |
| 19 19 | and published on [HexDocs](https://hexdocs.pm). Once published, the docs can |
| 20 20 | be found at [https://hexdocs.pm/islands_player_id](https://hexdocs.pm/islands_player_id). |
| 21 21 | |
| 22 | + [player_id]: https://hexdocs.pm/islands_player_id/Islands.PlayerID.html#t:t/0 |
| 23 | + [readme]: https://github.com/RaymondLoranger/islands_vue_client#readme |
| @@ -10,4 +10,4 @@ | |
| 10 10 | [{<<"GitHub">>,<<"https://github.com/RaymondLoranger/islands_player_id">>}]}. |
| 11 11 | {<<"name">>,<<"islands_player_id">>}. |
| 12 12 | {<<"requirements">>,[]}. |
| 13 | - {<<"version">>,<<"0.1.12">>}. |
| 13 | + {<<"version">>,<<"0.1.13">>}. |
| @@ -2,11 +2,15 @@ | |
| 2 2 | # │ Inspired by the book "Functional Web Development" by Lance Halvorsen. │ |
| 3 3 | # └───────────────────────────────────────────────────────────────────────┘ |
| 4 4 | defmodule Islands.PlayerID do |
| 5 | + @player_id "[`player ID`](`t:Islands.PlayerID.t/0`)" |
| 6 | + @readme "https://github.com/RaymondLoranger/islands_vue_client#readme" |
| 7 | + |
| 5 8 | @moduledoc """ |
| 6 | - Defines the `player ID` type for the _Game of Islands_. |
| 9 | + Defines the #{@player_id} type for the [Game of Islands](#{@readme}). |
| 7 10 | |
| 8 11 | ##### Inspired by the book [Functional Web Development](https://pragprog.com/book/lhelph/functional-web-development-with-elixir-otp-and-phoenix) by Lance Halvorsen. |
| 9 12 | """ |
| 10 13 | |
| 14 | + @typedoc "Player IDs for the Game of Islands" |
| 11 15 | @type t :: :player1 | :player2 |
| 12 16 | end |
| @@ -4,7 +4,7 @@ defmodule Islands.PlayerId.MixProject do | |
| 4 4 | def project do |
| 5 5 | [ |
| 6 6 | app: :islands_player_id, |
| 7 | - version: "0.1.12", |
| 7 | + version: "0.1.13", |
| 8 8 | elixir: "~> 1.11", |
| 9 9 | start_permanent: Mix.env() == :prod, |
| 10 10 | name: "Islands Player ID", |