paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-10 08:56:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

send_custom_email: Improve docstrings a bit.

Browse Source
This commit is contained in:
Tim Abbott
2020-04-14 10:55:04 -07:00
parent fcf4c9639e
commit 2732c477bc
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
zerver/management/commands/send_custom_email.py
View File

@@ -7,7 +7,13 @@ from zerver.models import UserProfile
class Command(ZulipBaseCommand): class Command(ZulipBaseCommand):
help = """Send email to specified email address.""" help = """
Send a custom email with Zulip branding to the specified users.
Useful to send a notice to all users of a realm or server.
The From and Subject headers can be provided in the body of the markdown
document used to generate the email, or on the command line."""
def add_arguments(self, parser: ArgumentParser) -> None: def add_arguments(self, parser: ArgumentParser) -> None:
parser.add_argument('--entire-server', action="store_true", default=False, parser.add_argument('--entire-server', action="store_true", default=False,
@@ -16,7 +22,7 @@ class Command(ZulipBaseCommand):
dest='markdown_template_path', dest='markdown_template_path',
required=True, required=True,
type=str, type=str,
help='Path to a markdown-format body for the email') help='Path to a markdown-format body for the email.')
parser.add_argument('--subject', parser.add_argument('--subject',
type=str, type=str,
help='Subject for the email. It can be declarated in markdown file in headers') help='Subject for the email. It can be declarated in markdown file in headers')