Apply last documentation touches

Author: ghivert

CHANGELOG.md

@@ -3,7 +3,6 @@
 ## v1.2.0 - Unreleased
 
 - Add support for formdata reading and editing.
-- Add documentation for every functions and improve README.
 
 ## v1.1.1 - 2025-02-06
 

README.md

@@ -3,29 +3,12 @@
 <a href="https://github.com/gleam-lang/fetch/releases"><img src="https://img.shields.io/github/release/gleam-lang/fetch" alt="GitHub release"></a>
 <a href="https://discord.gg/Fm8Pwmy"><img src="https://img.shields.io/discord/768594524158427167?color=blue" alt="Discord chat"></a>
 
-A library to use [`fetch`](https://developer.mozilla.org/docs/Web/API/Fetch_API), the built-in JavaScript HTTP client!
-
-## Features
-
-- Issue HTTP requests.
-- Handle HTTP responses in different formats (text, binary, JSON).
-- Read & Write [`FormData`](https://developer.mozilla.org/docs/Web/API/FormData).
-
-## Installation
-
-Add `gleam_fetch` & `gleam_http` to your Gleam project.
+Make HTTP requests in Gleam JavaScript with Fetch.
 
 ```sh
-gleam add gleam_http gleam_fetch
+gleam add gleam_fetch@1 gleam_http
 ```
 
-> [!WARNING]
-> If you are running your Gleam project on the Erlang target (the default for
-> new Gleam projects) then you will want to use a different library which can
-> run on Erlang, such as [`gleam_httpc`](https://github.com/gleam-lang/httpc).
-
-## Usage
-
 ```gleam
 pub fn main() {
   let assert Ok(req) = request.to("https://example.com")
@@ -47,5 +30,7 @@ pub fn main() {
 
 Documentation can be found at [https://hexdocs.pm/gleam_fetch](https://hexdocs.pm/gleam_fetch).
 
-`gleam_fetch` works on every JavaScript runtime implementing `fetch`, which
-implies all modern browsers, Node.js >= 18.0.0, Deno & Bun.
+> [!WARNING]
+> If you are running your Gleam project on the Erlang target (the default for
+> new Gleam projects) then you will want to use a different library which can
+> run on Erlang, such as [`gleam_httpc`](https://github.com/gleam-lang/httpc).

src/gleam/fetch.gleam

@@ -39,7 +39,6 @@ pub type FetchResponse
 /// |> request.set_path("/example")
 /// |> fetch.to_fetch_request
 /// |> fetch.raw_send
-/// // -> Promise(Result(FetchResponse, FetchError))
 /// ```
 @external(javascript, "../gleam_fetch_ffi.mjs", "raw_send")
 pub fn raw_send(a: FetchRequest) -> Promise(Result(FetchResponse, FetchError))
@@ -137,7 +136,6 @@ pub fn send_bits(
 ///   |> request.set_host("example.com")
 ///   |> request.set_path("/example")
 /// fetch.to_fetch_request(request)
-/// // -> FetchRequest
 /// ```
 @external(javascript, "../gleam_fetch_ffi.mjs", "to_fetch_request")
 pub fn to_fetch_request(a: Request(String)) -> FetchRequest
@@ -159,7 +157,6 @@ pub fn to_fetch_request(a: Request(String)) -> FetchRequest
 ///     |> form_data.append("key", "value")
 ///   })
 /// fetch.form_data_to_fetch_request(request)
-/// // -> FetchRequest
 /// ```
 @external(javascript, "../gleam_fetch_ffi.mjs", "form_data_to_fetch_request")
 pub fn form_data_to_fetch_request(a: Request(FormData)) -> FetchRequest
@@ -178,7 +175,6 @@ pub fn form_data_to_fetch_request(a: Request(FormData)) -> FetchRequest
 ///   |> request.set_path("/example")
 ///   |> request.set_body(<<"data">>)
 /// fetch.bitarray_request_to_fetch_request(request)
-/// // -> FetchRequest
 /// ```
 @external(javascript, "../gleam_fetch_ffi.mjs", "bitarray_request_to_fetch_request")
 pub fn bitarray_request_to_fetch_request(a: Request(BitArray)) -> FetchRequest
@@ -194,7 +190,6 @@ pub fn bitarray_request_to_fetch_request(a: Request(BitArray)) -> FetchRequest
 /// |> fetch.to_fetch_request
 /// |> fetch.raw_send
 /// |> promise.map_try(fetch.from_fetch_response)
-/// // -> Promise(Result(Response(FetchBody), FetchError))
 /// ```
 @external(javascript, "../gleam_fetch_ffi.mjs", "from_fetch_response")
 pub fn from_fetch_response(a: FetchResponse) -> Response(FetchBody)

src/gleam/fetch/form_data.gleam

@@ -26,40 +26,28 @@ import gleam/javascript/promise.{type Promise}
 /// ensure correct conversions between JavaScript & Gleam.
 pub type FormData
 
-/// Create a `FormData` without any data.
-///
-/// ```gleam
-/// import gleam/fetch/form_data
-/// form_data.new()
-/// // -> form_data.FormData
-/// ```
+/// Create a new empty `FormData`.
 @external(javascript, "../../gleam_fetch_ffi.mjs", "newFormData")
 pub fn new() -> FormData
 
 /// Append a key/string pair.
 ///
 /// ```gleam
-/// import gleam/fetch/form_data
 /// form_data.new()
 /// |> form_data.append("key1", "value1")
 /// |> form_data.append("key1", "value2")
 /// |> form_data.append("key2", "value1")
-/// // "key1" -> ["value1", "value2"]
-/// // "key2" -> ["value1"]
 /// ```
 @external(javascript, "../../gleam_fetch_ffi.mjs", "appendFormData")
 pub fn append(form_data: FormData, key: String, value: String) -> FormData
 
 /// Append a key/bitarray pair.
 ///
 /// ```gleam
-/// import gleam/fetch/form_data
 /// form_data.new()
 /// |> form_data.append_bits("key1", <<"value1">>)
 /// |> form_data.append_bits("key1", <<"value2">>)
 /// |> form_data.append_bits("key2", <<"value1">>)
-/// // "key1" -> [<<"value1">>, <<"value2">>]
-/// // "key2" -> [<<"value1">>]
 /// ```
 @external(javascript, "../../gleam_fetch_ffi.mjs", "appendBitsFormData")
 pub fn append_bits(
@@ -71,33 +59,28 @@ pub fn append_bits(
 /// Set key/string pair, and replace any existing value for the specified key.
 ///
 /// ```gleam
-/// import gleam/fetch/form_data
 /// form_data.new()
 /// |> form_data.append("key1", "value1")
 /// |> form_data.append_bits("key1", <<"value2">>)
 /// |> form_data.set("key1", "value3")
-/// // "key1" -> ["value3"]
 /// ```
 @external(javascript, "../../gleam_fetch_ffi.mjs", "setFormData")
 pub fn set(form_data: FormData, key: String, value: String) -> FormData
 
 /// Set key/bitarray pair, and replace any existing value for the specified key.
 ///
 /// ```gleam
-/// import gleam/fetch/form_data
 /// form_data.new()
 /// |> form_data.append("key1", "value1")
 /// |> form_data.append_bits("key1", <<"value2">>)
 /// |> form_data.set_bits("key1", <<"value3">>)
-/// // "key1" -> [<<"value3">>]
 /// ```
 @external(javascript, "../../gleam_fetch_ffi.mjs", "setBitsFormData")
 pub fn set_bits(form_data: FormData, key: String, value: BitArray) -> FormData
 
 /// Remove a key and all its existing values.
 ///
 /// ```gleam
-/// import gleam/fetch/form_data
 /// form_data.new()
 /// |> form_data.append("key1", "value1")
 /// |> form_data.append_bits("key1", <<"value2">>)
@@ -110,7 +93,6 @@ pub fn delete(form_data: FormData, key: String) -> FormData
 /// binary values, take a look at [`get_bits`](#get_bits).
 ///
 /// ```gleam
-/// import gleam/fetch/form_data
 /// form_data.new()
 /// |> form_data.append("key1", "value1")
 /// |> form_data.append_bits("key1", <<"value2">>)
@@ -125,7 +107,6 @@ pub fn get(form_data: FormData, key: String) -> List(String)
 /// a `Promise`.
 ///
 /// ```gleam
-/// import gleam/fetch/form_data
 /// form_data.new()
 /// |> form_data.append("key1", "value1")
 /// |> form_data.append_bits("key1", <<"value2">>)

src/gleam_fetch_ffi.mjs

@@ -164,4 +164,4 @@ export function keysFormData(formData) {
     result.add(key)
   }
   return toList([...result])
-}
+}