Commit 35d9d816 authored by Peter van der meulen's avatar Peter van der meulen

Add docs to forecast methods

parent dbafd0e2
......@@ -15,6 +15,12 @@ defmodule AuroraBot.Forecast do
@doc """
Returns an array of Forecast objects where for each day the highest kp is
provided at a specific time between 19:00 and 00:00 UTC
## example
iex> hello
[%AuroraBot.Forecast{datetime: ~N[2018-11-17 21:00:00], kp: 6}]
"""
def get! do
NOAAPlanetaryKForecast.get!()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment