From 7be64efc6bba47a190955e275bb06c0575b1b9be Mon Sep 17 00:00:00 2001
From: Parker Selbert <parker@sorentwo.com>
Date: Mon, 24 Jun 2024 10:21:48 -0500
Subject: [PATCH] Allow @doc_ module attributes beofre moduledoc

---
 .credo.exs | 2 +-
 README.md  | 6 ++++--
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/.credo.exs b/.credo.exs
index f3df5a3e..c0917ff0 100644
--- a/.credo.exs
+++ b/.credo.exs
@@ -98,7 +98,7 @@
         #
         # Controversial and experimental checks (opt-in, just replace `false` with `[]`)
         #
-        {Credo.Check.Readability.StrictModuleLayout, []},
+        {Credo.Check.Readability.StrictModuleLayout, ignore_module_attributes: ~w(doc_header doc_footer)a},
         {Credo.Check.Consistency.MultiAliasImportRequireUse, false},
         {Credo.Check.Consistency.UnusedVariableNames, false},
         {Credo.Check.Design.DuplicatedCode, false},
diff --git a/README.md b/README.md
index 3a604a66..9f343f36 100644
--- a/README.md
+++ b/README.md
@@ -53,8 +53,10 @@
 
 ---
 
-_Note: This README is for the unreleased main branch, please reference the
-[official documentation on hexdocs][hexdoc] for the latest stable release._
+> [!NOTE]
+>
+> This README is for the unreleased main branch, please reference the
+> [official documentation on hexdocs][hexdoc] for the latest stable release.
 
 [hexdoc]: https://hexdocs.pm/oban/Oban.html