From 3bbba9f78da33c3ad9dc659b98d228ad56e4b17b Mon Sep 17 00:00:00 2001
From: Kevin Schweikert <kevin@kevinschweikert.de>
Date: Sun, 22 Dec 2024 12:39:40 +0100
Subject: [PATCH] add example code to `Plug.Conn.Cookies.encode/2`

---
 lib/plug/conn/cookies.ex | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/lib/plug/conn/cookies.ex b/lib/plug/conn/cookies.ex
index 9634b025..d97a5f64 100644
--- a/lib/plug/conn/cookies.ex
+++ b/lib/plug/conn/cookies.ex
@@ -56,6 +56,14 @@ defmodule Plug.Conn.Cookies do
 
   @doc """
   Encodes the given cookies as expected in a response header.
+
+  ## Examples
+
+      iex> encode("key1", %{value: "value1"})
+      "key1=value1; path=/; HttpOnly"
+
+      iex> encode("key1", %{value: "value1", secure: true, path: "/example", http_only: false})
+      "key1=value1; path=/example; secure"
   """
   def encode(key, opts \\ %{}) when is_map(opts) do
     value = Map.get(opts, :value)