Skip to content

Commit 45622da

Browse files
Change docstring to be more accurate
1 parent 4d4c4c8 commit 45622da

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/imcflibs/imagej/misc.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,21 @@ def send_notification_email(job_name, recipient, filename, total_execution_time,
189189
The name of the file to be passed in the email.
190190
total_execution_time : str
191191
The time it took to process the file in the format [HH:MM:SS:ss].
192+
subject : string, optional
193+
Subject of the email, by default says job finished.
194+
message : string, optional
195+
Message to be included in the email, by default says job processed.
196+
197+
Notes
198+
-----
199+
- The function requires two preferences to be set in `~/.imagej/IJ_Prefs.txt`:
200+
`imcf.sender_email` (the sender's email address) and
201+
`imcf.smtpserver` (the SMTP server address).
202+
- If these preferences are not set or if required parameters are missing,
203+
the function logs a message and exits without sending an email.
204+
- In case of an SMTP error, the function logs a warning.
192205
"""
206+
193207
# Retrieve sender email and SMTP server from preferences
194208
sender = prefs.Prefs.get("imcf.sender_email", "").strip()
195209
server = prefs.Prefs.get("imcf.smtpserver", "").strip()

0 commit comments

Comments
 (0)