Skip to content

Commit 69dbd37

Browse files
authored
docs: Update function name in SystemStatus.Alerts docs to be linkable (#2340)
Elixir docs will add a link to a function's docs if it's referenced like `active_on_day?/2`, but not if it's referenced like `&active_on_day?/2`. Thus, what I had thought was a link wasn't. This fixes that.
1 parent f9a82c9 commit 69dbd37

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

lib/dotcom/system_status/alerts.ex

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,7 @@ defmodule Dotcom.SystemStatus.Alerts do
6666
end
6767

6868
@doc """
69-
Given a list of alerts, filters only the ones that are active today, as defined in `&active_on_day?/2`.
70-
See that function for details
69+
Given a list of alerts, filters only the ones that are active today, as defined in `active_on_day?/2`.
7170
"""
7271
def for_day(alerts, datetime) do
7372
Enum.filter(alerts, &active_on_day?(&1, datetime))

0 commit comments

Comments
 (0)