Skip to content

Commit

Permalink
docs: Update function name in SystemStatus.Alerts docs to be linkable (
Browse files Browse the repository at this point in the history
…#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.
  • Loading branch information
joshlarson authored Jan 22, 2025
1 parent f9a82c9 commit 69dbd37
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions lib/dotcom/system_status/alerts.ex
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,7 @@ defmodule Dotcom.SystemStatus.Alerts do
end

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

0 comments on commit 69dbd37

Please sign in to comment.