From 8103ab3e5123c95b494ca5fee2cb5308af8c3ada Mon Sep 17 00:00:00 2001
From: Pierre-Yves Chibon <pingou@pingoured.fr>
Date: Feb 01 2018 12:47:12 +0000
Subject: Improve the fedmsg git hook documentation


Fixes https://pagure.io/pagure/issue/2931
Signed-off-by: Pierre-Yves Chibon <pingou@pingoured.fr>

---

diff --git a/pagure/hooks/fedmsg.py b/pagure/hooks/fedmsg.py
index 6c9890f..c9f0e6b 100644
--- a/pagure/hooks/fedmsg.py
+++ b/pagure/hooks/fedmsg.py
@@ -57,12 +57,23 @@ class FedmsgForm(FlaskForm):
     )
 
 
+DESCRIPTION = '''
+This hook pushes commit notification to the fedmsg bus to be consumed by other
+applications.
+
+It is different from the fedmsg setting present in the project options block
+which publishes notifications about events happening in the project via
+pagure's (web) user interface, for example: new tickets, new comments, new
+pull-requests and so on.
+This hook on the other only acts on commits.
+'''
+
+
 class Fedmsg(BaseHook):
     ''' Fedmsg hooks. '''
 
     name = 'Fedmsg'
-    description = 'This hook pushes the commit messages'\
-        ' to the Fedora bus to be consumed by other applications.'
+    description = DESCRIPTION
     form = FedmsgForm
     db_object = FedmsgTable
     backref = 'fedmsg_hook'