hotfix: resolve publish warnings about broken links in docs

Author: nrednav

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v1.1.1] - 2025-08-09
+
+### Fixed
+
+- Fixed broken links in documentation
+
 ## [v1.1.0] - 2025-08-09
 
 ### Added

lib/msgpack/stream_decoder.ex

@@ -23,10 +23,17 @@ defmodule Msgpack.StreamDecoder do
   alias Msgpack.Decoder
   alias Msgpack.Decoder.Internal
 
-  @typedoc "A stream that yields decoded Elixir terms."
-  @type t :: Stream.t()
+  @typedoc """
+  A stream that yields decoded Elixir terms or a final error tuple.
 
-  @typedoc "Options passed to the decoder."
+  The stream will produce any t:term/0 that can be decoded from the input.
+
+  If the input enumerable finishes while a term is only partially decoded, the
+  last element in the stream will be {:error, :unexpected_eof}.
+  """
+  @type t :: Stream.t(term() | {:error, :unexpected_eof})
+
+  @typedoc "Options passed to the decoder for each object."
   @type opts_t :: keyword()
 
   @doc """
@@ -36,7 +43,7 @@ defmodule Msgpack.StreamDecoder do
   ## Parameters
 
     * `enumerable`: An `Enumerable` that yields chunks of a MessagePack binary
-    stream (e.g., `File.stream/3` or a list of binaries).
+    stream (e.g., `f:File.stream/3` or a list of binaries).
     * `opts`: A keyword list of options passed to the underlying decoder.
 
   ## Return Value
@@ -90,7 +97,11 @@ defmodule Msgpack.StreamDecoder do
   end
 
   @doc false
-  @spec transform_chunk(binary() | :eof, {binary(), opts_t()}) :: {list(), {binary(), opts_t() | nil}}
+  @spec transform_chunk(
+          binary() | :eof,
+          {binary(), opts_t()}
+        ) ::
+          {list(term() | {:error, :unexpected_eof}), {binary(), opts_t() | nil}}
   defp transform_chunk(:eof, {<<>>, _opts}) do
     {[], {<<>>, nil}}
   end
@@ -105,7 +116,7 @@ defmodule Msgpack.StreamDecoder do
   end
 
   @doc false
-  @spec do_transform(binary(), opts_t(), list()) :: {list(), binary()}
+  @spec do_transform(binary(), opts_t(), list(term())) :: {list(term()), binary()}
   defp do_transform(<<>>, _opts, acc) do
     {Enum.reverse(acc), <<>>}
   end

lib/msgpack/stream_encoder.ex

@@ -12,13 +12,19 @@ defmodule Msgpack.StreamEncoder do
   not be encoded.
   """
 
-  @typedoc "A stream that yields encoded MessagePack objects."
+  @typedoc """
+  A stream that yields result tuples from an encoding operation.
+
+  Each element is either `{:ok, binary}` or `{:error, reason}`.
+  """
   @type t :: Stream.t(result_t())
 
-  @typedoc "An individual result from the encoding stream."
+  @typedoc """
+  The result of attempting to encode a single term.
+  """
   @type result_t :: {:ok, binary()} | {:error, any()}
 
-  @typedoc "Options passed to the encoder."
+  @typedoc "Options passed to the encoder for each term."
   @type opts_t :: keyword()
 
   @doc """
@@ -66,7 +72,7 @@ defmodule Msgpack.StreamEncoder do
   ]
   ```
   """
-  @spec encode(Enumerable.t(), opts_t()) :: t()
+  @spec encode(Enumerable.t(any()), opts_t()) :: t()
   def encode(enumerable, opts \\ []) do
     Stream.map(enumerable, &Msgpack.encode(&1, opts))
   end

mix.exs

@@ -1,7 +1,7 @@
 defmodule MsgpackElixir.MixProject do
   use Mix.Project
 
-  @version "1.1.0"
+  @version "1.1.1"
   @source_url "https://github.com/nrednav/msgpack_elixir"
 
   def project do
@@ -60,6 +60,7 @@ defmodule MsgpackElixir.MixProject do
       extras: [
         "README.md",
         "CHANGELOG.md",
+        "LICENSE",
         "guides/telemetry.md"
       ]
     ]