Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document #80 workaround for now #81

Merged
merged 1 commit into from
May 26, 2020
Merged

Document #80 workaround for now #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,6 +426,7 @@ defmodule Colors do
def hex(), do: spec(is_binary() and &String.starts_with?(&1, "#"))

@contract rgb_to_hex(r :: rgb(), g :: rgb(), b :: rgb()) :: hex()
@doc "Convert an RGB value to its CSS-style hexadecimal notation."
def rgb_to_hex(r, g, b) do
# ...
end
Expand All @@ -436,6 +437,9 @@ If the arguments for `rgb_to_hex` don't conform to the specification or if
`rgb_to_hex` does not return a value that conforms to `hex` then an error will
be raised.

Note `@contract` must be placed _before_ `@doc` as above for `ExDoc` and
`ExUnit.DocTest` to continue working as intended.

<!-- MDOC !-->

## Installation
Expand Down