Skip to content

Commit abe350d

Browse files
Stuart EcclesStuart Eccles
authored andcommitted
fixed some markup
1 parent 66397d0 commit abe350d

3 files changed

Lines changed: 14 additions & 14 deletions

File tree

lib/segment/analytics.ex

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ defmodule Segment.Analytics do
2727
`track` lets you record the actions your users perform. Every action triggers what Segment call an “event”, which can also have associated properties as defined in the
2828
`Segment.Analytics.Track` struct
2929
30-
See (https://segment.com/docs/spec/track/)[https://segment.com/docs/spec/track/]
30+
See [https://segment.com/docs/spec/track/](https://segment.com/docs/spec/track/)
3131
"""
3232
@spec track(Segment.Analytics.Track.t()) :: :ok
3333
def track(t = %Track{}) do
@@ -38,7 +38,7 @@ defmodule Segment.Analytics do
3838
`track` lets you record the actions your users perform. Every action triggers what Segment call an “event”, which can also have associated properties. `track/4` takes a `user_id`, an
3939
`event_name`, optional additional `properties` and an optional `Segment.Analytics.Context` struct.
4040
41-
See (https://segment.com/docs/spec/track/)[https://segment.com/docs/spec/track/]
41+
See [https://segment.com/docs/spec/track/](https://segment.com/docs/spec/track/)
4242
"""
4343
@spec track(segment_id(), String.t(), map(), Segment.Analytics.Context.t()) :: :ok
4444
def track(user_id, event_name, properties \\ %{}, context \\ Context.new()) do
@@ -55,7 +55,7 @@ defmodule Segment.Analytics do
5555
`identify` lets you tie a user to their actions and record traits about them as defined in the
5656
`Segment.Analytics.Identify` struct
5757
58-
See (https://segment.com/docs/spec/identify/)[https://segment.com/docs/spec/identify/]
58+
See [https://segment.com/docs/spec/identify/](https://segment.com/docs/spec/identify/)
5959
"""
6060
@spec identify(Segment.Analytics.Identify.t()) :: :ok
6161
def identify(i = %Identify{}) do
@@ -65,7 +65,7 @@ defmodule Segment.Analytics do
6565
@doc """
6666
`identify` lets you tie a user to their actions and record traits about them. `identify/3` takes a `user_id`, optional additional `traits` and an optional `Segment.Analytics.Context` struct.
6767
68-
See (https://segment.com/docs/spec/identify/)[https://segment.com/docs/spec/identify/]
68+
See [https://segment.com/docs/spec/identify/](https://segment.com/docs/spec/identify/)
6969
"""
7070
@spec identify(segment_id(), map(), Segment.Analytics.Context.t()) :: :ok
7171
def identify(user_id, traits \\ %{}, context \\ Context.new()) do
@@ -77,7 +77,7 @@ defmodule Segment.Analytics do
7777
`screen` let you record whenever a user sees a screen of your mobile app with properties defined in the
7878
`Segment.Analytics.Screen` struct
7979
80-
See (https://segment.com/docs/spec/screen/)[https://segment.com/docs/spec/screen/]
80+
See [https://segment.com/docs/spec/screen/](https://segment.com/docs/spec/screen/)
8181
"""
8282
@spec screen(Segment.Analytics.Screen.t()) :: :ok
8383
def screen(s = %Screen{}) do
@@ -87,7 +87,7 @@ defmodule Segment.Analytics do
8787
@doc """
8888
`screen` let you record whenever a user sees a screen of your mobile app. `screen/4` takes a `user_id`, an optional `screen_name`, optional `properties` and an optional `Segment.Analytics.Context` struct.
8989
90-
See (https://segment.com/docs/spec/screen/)[https://segment.com/docs/spec/screen/]
90+
See [https://segment.com/docs/spec/screen/](https://segment.com/docs/spec/screen/)
9191
"""
9292
@spec screen(segment_id(), String.t(), map(), Segment.Analytics.Context.t()) :: :ok
9393
def screen(user_id, screen_name \\ "", properties \\ %{}, context \\ Context.new()) do
@@ -103,7 +103,7 @@ defmodule Segment.Analytics do
103103
@doc """
104104
`alias` is how you associate one identity with another with properties defined in the `Segment.Analytics.Alias` struct
105105
106-
See (https://segment.com/docs/spec/alias/)[https://segment.com/docs/spec/alias/]
106+
See [https://segment.com/docs/spec/alias/](https://segment.com/docs/spec/alias/)
107107
"""
108108
@spec alias(Segment.Analytics.Alias.t()) :: :ok
109109
def alias(a = %Alias{}) do
@@ -113,7 +113,7 @@ defmodule Segment.Analytics do
113113
@doc """
114114
`alias` is how you associate one identity with another. `alias/3` takes a `user_id` and a `previous_id` to map from. It also takes an optional `Segment.Analytics.Context` struct.
115115
116-
See (https://segment.com/docs/spec/alias/)[https://segment.com/docs/spec/alias/]
116+
See [https://segment.com/docs/spec/alias/](https://segment.com/docs/spec/alias/)
117117
"""
118118
@spec alias(segment_id(), segment_id(), Segment.Analytics.Context.t()) :: :ok
119119
def alias(user_id, previous_id, context \\ Context.new()) do
@@ -124,7 +124,7 @@ defmodule Segment.Analytics do
124124
@doc """
125125
The `group` call is how you associate an individual user with a group with the properties in the defined in the `Segment.Analytics.Group` struct
126126
127-
See (https://segment.com/docs/spec/group/)[https://segment.com/docs/spec/group/]
127+
See [https://segment.com/docs/spec/group/](https://segment.com/docs/spec/group/)
128128
"""
129129
@spec group(Segment.Analytics.Group.t()) :: :ok
130130
def group(g = %Group{}) do
@@ -135,7 +135,7 @@ defmodule Segment.Analytics do
135135
The `group` call is how you associate an individual user with a group. `group/4` takes a `user_id` and a `group_id` to associate it with. It also takes optional `traits` of the group and
136136
an optional `Segment.Analytics.Context` struct.
137137
138-
See (https://segment.com/docs/spec/group/)[https://segment.com/docs/spec/group/]
138+
See [https://segment.com/docs/spec/group/](https://segment.com/docs/spec/group/)
139139
"""
140140
@spec group(segment_id(), segment_id(), map(), Segment.Analytics.Context.t()) :: :ok
141141
def group(user_id, group_id, traits \\ %{}, context \\ Context.new()) do
@@ -146,7 +146,7 @@ defmodule Segment.Analytics do
146146
@doc """
147147
The `page` call lets you record whenever a user sees a page of your website with the properties defined in the `Segment.Analytics.Page` struct
148148
149-
See (https://segment.com/docs/spec/page/)[https://segment.com/docs/spec/page/]
149+
See [https://segment.com/docs/spec/page/](https://segment.com/docs/spec/page/)
150150
"""
151151
@spec page(Segment.Analytics.Page.t()) :: :ok
152152
def page(p = %Page{}) do
@@ -156,7 +156,7 @@ defmodule Segment.Analytics do
156156
@doc """
157157
The `page` call lets you record whenever a user sees a page of your website. `page/4` takes a `user_id` and an optional `page_name`, optional `properties and an optional `Segment.Analytics.Context` struct.
158158
159-
See (https://segment.com/docs/spec/page/)[https://segment.com/docs/spec/page/]
159+
See [https://segment.com/docs/spec/page/](https://segment.com/docs/spec/page/)
160160
"""
161161
@spec page(segment_id(), String.t(), map(), Segment.Analytics.Context.t()) :: :ok
162162
def page(user_id, page_name \\ "", properties \\ %{}, context \\ Context.new()) do

lib/segment/batcher.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
defmodule Segment.Analytics.Batcher do
22
@moduledoc """
33
The `Segment.Analytics.Batcher` module is the default service implementation for the library which uses the
4-
(Segment Batch HTTP API)[https://segment.com/docs/sources/server/http/#batch] to put events in a FIFO queue and
4+
[Segment Batch HTTP API](https://segment.com/docs/sources/server/http/#batch) to put events in a FIFO queue and
55
send on a regular basis.
66
77
The `Segment.Analytics.Batcher` can be configured with

lib/segment/client/http.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ defmodule Segment.Http do
111111
Send a list of Segment events as a batch.
112112
113113
The `batch` function takes optional arguments for context and integrations which can
114-
be applied to the entire batch of events. See (Segments docs)[https://segment.com/docs/sources/server/http/#batch]
114+
be applied to the entire batch of events. See [Segment's docs](https://segment.com/docs/sources/server/http/#batch)
115115
"""
116116
@spec batch(String.t(), list(Segment.segment_event()), map(), map()) :: :ok | :error
117117
def batch(client, events, context \\ nil, integrations \\ nil) do

0 commit comments

Comments
 (0)