Skip to content

Commit 4acffe8

Browse files
fix(elixir): resolve mix docs warnings in templates
- streaming.j2: add @moduledoc (was hidden) - errors.j2: use Exception.t() instead of Splode macro types, drop UnknownError from typedoc Amp-Thread-ID: https://ampcode.com/threads/T-019c390a-abe3-726d-a4a1-9cfc2522667b Co-authored-by: Amp <amp@ampcode.com>
1 parent 5ceeb93 commit 4acffe8

2 files changed

Lines changed: 13 additions & 7 deletions

File tree

xdk-gen/templates/elixir/errors.j2

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,13 @@ defmodule Xdk.Errors do
99
],
1010
unknown_error: Xdk.Errors.UnknownError
1111

12-
@type error ::
13-
Xdk.Errors.ApiError.t()
14-
| Xdk.Errors.RateLimitError.t()
15-
| Xdk.Errors.TransportError.t()
16-
| Xdk.Errors.DecodeError.t()
17-
| Xdk.Errors.UnknownError.t()
12+
@typedoc """
13+
Any error returned by the XDK client.
14+
15+
One of `Xdk.Errors.ApiError`, `Xdk.Errors.RateLimitError`,
16+
`Xdk.Errors.TransportError`, or `Xdk.Errors.DecodeError`.
17+
"""
18+
@type error :: Exception.t()
1819
end
1920

2021
defmodule Xdk.Errors.Api do

xdk-gen/templates/elixir/streaming.j2

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
{% raw %}
22
defmodule Xdk.Streaming do
3-
@moduledoc false
3+
@moduledoc """
4+
Low-level NDJSON streaming helper for the X API.
5+
6+
Used internally by `Xdk.Stream` to consume newline-delimited JSON
7+
streams (filtered stream, sample stream, etc.).
8+
"""
49

510
@spec ndjson_stream(Xdk.t(), atom(), String.t(), keyword()) :: Enumerable.t()
611
def ndjson_stream(%Xdk{} = client, method, path, opts \\ []) do

0 commit comments

Comments
 (0)