Skip to content

Commit

Permalink
Add comment to send_cookie_email
Browse files Browse the repository at this point in the history
Add docstring comment to send_cookie_email
  • Loading branch information
ItIsJordan committed Aug 21, 2024
1 parent 3427a6d commit 2d6a94f
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions hepdata/modules/email/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,15 @@ def notify_subscribers(hepsubmission, record):

def send_cookie_email(submission_participant,
record_information, message=None, version=1):
"""
Sends an email to either an uploader, or reviewer containing their invitation cookie/token
and any custom messaging.
:param submission_participant: A SubmissionParticipant object, to receive the email reminder
:param record_information: Record object containing record information
:param version: The record version (Default is 1)
:param message: Any specific message text input into the form (Default is None)
"""
hepsubmission = get_latest_hepsubmission(
publication_recid=record_information['recid']
)
Expand Down

0 comments on commit 2d6a94f

Please sign in to comment.