Add missing dots in docstrings. Add sendNotification parameters description to docstring in soc.logic.helper module.
Patch by: Pawel Solyga
Review by: to-be-reviewed
--- a/app/soc/logic/helper/notifications.py Tue Jan 20 14:12:54 2009 +0000
+++ b/app/soc/logic/helper/notifications.py Tue Jan 20 15:59:07 2009 +0000
@@ -90,7 +90,7 @@
def sendNewClubNotification(entity):
- """Sends out an invite notification to the applicant of the club
+ """Sends out an invite notification to the applicant of the club.
Args:
entity : An accepted club application
@@ -121,7 +121,10 @@
"""Sends out an notification to the specified user.
Args:
- entity : A request containing the information needed to create the message
+ to_user : user to which the notification will be send
+ message_properties : email message properties
+ subject : subject of notification email
+ template : template used for generating notification
"""
from_user = model_logic.user.logic.getForCurrentAccount()
@@ -151,7 +154,7 @@
def sendNewNotificationMessage(notification_entity):
- """Sends an email to a user about a new notification
+ """Sends an email to a user about a new notification.
Args:
notification_entity: Notification about which the message should be sent