Link back journal.rb to docs/hooks.md

floraison · Mar 6, 2024 · 1160f4d · 1160f4d
1 parent 7fe24d0
commit 1160f4d
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/flor/unit/journal.rb b/lib/flor/unit/journal.rb
@@ -1,7 +1,15 @@
 # frozen_string_literal: true
 
+
 module Flor
 
+  # As seen in docs/hooks.md
+  #
+  # ```ruby
+  # flor.hooker.add('journal', Flor::Journal)
+  # ```
+  #
+  #
   # A Journal hook, receives only "consumed" messages and
   # keeps a copy of all of them.
   #