Browse Source

evt => event in hook name, params in docstring

haliphax 7 years ago
parent
commit
42de9130b9
2 changed files with 10 additions and 4 deletions
  1. 4 2
      flaskbb/forum/models.py
  2. 6 2
      flaskbb/plugins/spec.py

+ 4 - 2
flaskbb/forum/models.py

@@ -205,7 +205,8 @@ class Post(HideableCRUDMixin, db.Model):
         if self.id:
         if self.id:
             db.session.add(self)
             db.session.add(self)
             db.session.commit()
             db.session.commit()
-            current_app.pluggy.hook.flaskbb_evt_after_post(post=self, is_new=False)
+            current_app.pluggy.hook.flaskbb_event_after_post(post=self,
+                                                             is_new=False)
             return self
             return self
 
 
         # Adding a new post
         # Adding a new post
@@ -235,7 +236,8 @@ class Post(HideableCRUDMixin, db.Model):
             # And commit it!
             # And commit it!
             db.session.add(topic)
             db.session.add(topic)
             db.session.commit()
             db.session.commit()
-            current_app.pluggy.hook.flaskbb_evt_after_post(post=self, is_new=True)
+            current_app.pluggy.hook.flaskbb_event_after_post(post=self,
+                                                             is_new=True)
             return self
             return self
 
 
     def delete(self):
     def delete(self):

+ 6 - 2
flaskbb/plugins/spec.py

@@ -148,5 +148,9 @@ def flaskbb_tpl_profile_settings_menu():
 # Event hooks
 # Event hooks
 
 
 @spec
 @spec
-def flaskbb_evt_after_post(post, is_new):
+def flaskbb_event_after_post(post, is_new):
-    """Hook for handling a post after it has been saved."""
+    """Hook for handling a post after it has been saved.
+
+    :param flaskbb.forum.models.Post post: The post which triggered the event
+    :param bool is_new: True if the post is new, False if it is an edit
+    """