Allow @doc_ module attributes beofre moduledoc

sorentwo · Jun 25, 2024 · 7be64ef · 7be64ef
1 parent da9b573
commit 7be64ef
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git 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
@@ -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