♻️ Fix typo errors

config/.credo.exs

@@ -70,7 +70,7 @@
         # If you don't want TODO comments to cause `mix credo` to fail, just
         # set this value to 0 (zero).
         #
-        {Credo.Check.Design.TagTODO, false},
+        {Credo.Check.Design.TagTODO, [priority: :low]},
         {Credo.Check.Design.TagFIXME, []},
 
         #

guides/introduction/getting-started.md

@@ -237,7 +237,7 @@ defmodule LoginServer.Auth.Actions do
     # Send the response to the client
     Client.send(client, render)
 
-    # We continue to receive packages from the client
+    # We continue to receive packets from the client
     {:cont, client}
   end
 
@@ -295,7 +295,7 @@ SUCCESS 127.0.0.1:1234  # Client response
 ```
 
 ```
-#Back to terminal 1, we also received several messages due to the application logs
+# Back to terminal 1, we also received several messages due to the application logs
 XX:XX:XX.XX [info]  Login server started on port 3000
 XX:XX:XX.XX [info]  New connection: 226167fe-493f-47ea-ae81-5f94e0e728ed
 XX:XX:XX.XX [info]  New message from 226167fe-493f-47ea-ae81-5f94e0e728ed (len: 5)

lib/elven_gard/exceptions.ex

@@ -15,7 +15,7 @@ defmodule ElvenGard.UnknownViewError do
 
   @impl true
   def message(%{parent: parent, type: type}) do
-    "Unable to find the `render/2` function with the '#{inspect(type)}' key " <>
+    "unable to find the `render/2` function with the '#{inspect(type)}' key " <>
       "(from #{inspect(parent)})"
   end
 end

lib/elven_gard/packet.ex

@@ -44,7 +44,7 @@ defmodule ElvenGard.Packet do
         {:cont, client}
       end
 
-      def get_packet_definitions() do
+      def fetch_definitions() do
         @elven_packet_definitions
       end
     end

lib/elven_gard/protocol/binary.ex

@@ -18,7 +18,7 @@ defmodule ElvenGard.Protocol.Binary do
   @doc false
   defmacro __using__(model: model) do
     expanded_model = Macro.expand(model, __CALLER__)
-    defs = expanded_model.get_packet_definitions()
+    defs = expanded_model.fetch_definitions()
 
     :ok = check_types!(defs)
 
@@ -40,7 +40,7 @@ defmodule ElvenGard.Protocol.Binary do
       end
 
       ## Define sub decoders
-      Enum.each(unquote(model).get_packet_definitions(), fn packet ->
+      Enum.each(unquote(model).fetch_definitions(), fn packet ->
         name = packet.name
         fields = Macro.escape(packet.fields)
 

lib/elven_gard/protocol/textual.ex

@@ -15,7 +15,7 @@ defmodule ElvenGard.Protocol.Textual do
   @doc false
   defmacro __using__(model: model, separator: separator) do
     expanded_model = Macro.expand(model, __CALLER__)
-    defs = expanded_model.get_packet_definitions()
+    defs = expanded_model.fetch_definitions()
 
     check_types!(defs)
 
@@ -44,7 +44,7 @@ defmodule ElvenGard.Protocol.Textual do
       defp pre_textual_decode(x) when is_list(x), do: Enum.map(x, &textual_decode/1)
 
       ## Define sub decoders
-      Enum.each(unquote(model).get_packet_definitions(), fn packet ->
+      Enum.each(unquote(model).fetch_definitions(), fn packet ->
         name = packet.name
         fields = Macro.escape(packet.fields)
         sep = unquote(separator) |> Macro.escape()

lib/elven_gard/type.ex

@@ -14,7 +14,7 @@ defmodule ElvenGard.Type do
   @callback encode(decoded_term, opts :: list) :: term
 
   @doc """
-  Transforms a packet received by a client into a term that can be used by a protocol
+  Transforms a packet received by a client into a term that can be used by `ElvenGard.Protocol`
 
   NOTE: The result of this function will then be used by `c:ElvenGard.Protocol.decode/1`
   """

mix.exs

@@ -113,7 +113,7 @@ defmodule ElvenGard.MixProject do
   end
 
   defp extras() do
-    ["README.md": [title: "Project Description"]] ++ Path.wildcard("guides/**/*.md")
+    ["README.md": [title: "Overview"]] ++ Path.wildcard("guides/**/*.md")
   end
 
   defp groups_for_extras() do

test/lib/elven_gard/packet_test.exs

@@ -152,7 +152,7 @@ defmodule ElvenGard.PacketTest do
 
   describe "Invalid packet:" do
     test "no documentation" do
-      got = InvalidPacketHandler.get_packet_definitions()
+      got = InvalidPacketHandler.fetch_definitions()
       expected = []
 
       assert got == expected
@@ -161,7 +161,7 @@ defmodule ElvenGard.PacketTest do
 
   describe "No field, single packet defined with" do
     test "no documentation" do
-      got = BasicPacketHandler.get_packet_definitions()
+      got = BasicPacketHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{
@@ -176,7 +176,7 @@ defmodule ElvenGard.PacketTest do
     end
 
     test "documentation" do
-      got = WithDescHandler.get_packet_definitions()
+      got = WithDescHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{
@@ -191,7 +191,7 @@ defmodule ElvenGard.PacketTest do
     end
 
     test "multiline documentation" do
-      got = MultilineDescHandler.get_packet_definitions()
+      got = MultilineDescHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{
@@ -206,7 +206,7 @@ defmodule ElvenGard.PacketTest do
     end
 
     test "documentations previously set" do
-      got = AttributeDescHandler.get_packet_definitions()
+      got = AttributeDescHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{
@@ -223,7 +223,7 @@ defmodule ElvenGard.PacketTest do
 
   describe "Single packet, single field defined with" do
     test "no documentation" do
-      got = FieldHandler.get_packet_definitions()
+      got = FieldHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{
@@ -245,7 +245,7 @@ defmodule ElvenGard.PacketTest do
     end
 
     test "attribute documentation" do
-      got = FieldDescHandler.get_packet_definitions()
+      got = FieldDescHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{
@@ -267,7 +267,7 @@ defmodule ElvenGard.PacketTest do
     end
 
     test "documentation option" do
-      got = FieldDescOptsHandler.get_packet_definitions()
+      got = FieldDescOptsHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{
@@ -289,7 +289,7 @@ defmodule ElvenGard.PacketTest do
     end
 
     test "multiline documentation" do
-      got = FieldMultilineDescHandler.get_packet_definitions()
+      got = FieldMultilineDescHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{
@@ -311,7 +311,7 @@ defmodule ElvenGard.PacketTest do
     end
 
     test "documentations previously set" do
-      got = FieldDescAttributeHandler.get_packet_definitions()
+      got = FieldDescAttributeHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{
@@ -335,7 +335,7 @@ defmodule ElvenGard.PacketTest do
 
   describe "Tagged packet" do
     test "no documentation" do
-      got = UselessHandler.get_packet_definitions()
+      got = UselessHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{
@@ -350,7 +350,7 @@ defmodule ElvenGard.PacketTest do
     end
 
     test "documentation" do
-      got = UselessWithDescHandler.get_packet_definitions()
+      got = UselessWithDescHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{
@@ -367,7 +367,7 @@ defmodule ElvenGard.PacketTest do
 
   describe "Final test:" do
     test "Multiple packet, multiple fields, tagged or not, documented or not" do
-      got = CompleteHandler.get_packet_definitions()
+      got = CompleteHandler.fetch_definitions()
 
       expected = [
         %PacketDefinition{