Skip to content

Commit ec50c1a

Browse files
committed
docs: remove inexistent named argument
1 parent bea87aa commit ec50c1a

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/remote_data.gleam

+8-8
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ pub fn map(
3838
///
3939
/// ## Examples
4040
/// ```gleam
41-
/// map_2(over: Success(1), over_2: Success(2), with: fn(a, b) { a + b })
41+
/// map_2(over: Success(1), over2: Success(2), with: fn(a, b) { a + b })
4242
/// // -> Success(3)
4343
/// ```
4444
///
4545
/// ```gleam
46-
/// map_2(over: Failure("error"), over_2: Success(2), with: fn(a, b) { a + b })
46+
/// map_2(over: Failure("error"), over2: Success(2), with: fn(a, b) { a + b })
4747
/// // -> Failure("error")
4848
/// ```
4949
pub fn map2(
@@ -63,8 +63,8 @@ pub fn map2(
6363
/// Check `map2` for more details
6464
pub fn map3(
6565
over data1: RemoteData(a, error),
66-
over_2 data2: RemoteData(b, error),
67-
over_3 data3: RemoteData(c, error),
66+
over2 data2: RemoteData(b, error),
67+
over3 data3: RemoteData(c, error),
6868
with mapper: fn(a, b, c) -> d,
6969
) -> RemoteData(d, error) {
7070
case data1, data2, data3 {
@@ -168,12 +168,12 @@ pub fn to_option(data: RemoteData(a, error)) -> Option(a) {
168168
/// Convert an Option to a RemoteData
169169
/// ## Examples
170170
/// ```gleam
171-
/// from_option(option: Some(1), or: "error")
171+
/// from_option(Some(1), or: "error")
172172
/// // -> Success(1)
173173
/// ```
174174
///
175175
/// ```gleam
176-
/// from_option(option: None, or: "error")
176+
/// from_option(None, or: "error")
177177
/// // -> Failure("error")
178178
/// ```
179179
pub fn from_option(option: Option(a), or error: error) -> RemoteData(a, error) {
@@ -214,12 +214,12 @@ pub fn to_result(
214214
/// Convert a Result to a RemoteData
215215
/// ## Examples
216216
/// ```gleam
217-
/// from_result(result: Ok(1))
217+
/// from_result(Ok(1))
218218
/// // -> Success(1)
219219
/// ```
220220
///
221221
/// ```gleam
222-
/// from_result(result: Error("error"))
222+
/// from_result(Error("error"))
223223
/// // -> Failure("error")
224224
/// ```
225225
pub fn from_result(result: Result(a, error)) -> RemoteData(a, error) {

0 commit comments

Comments
 (0)