Bug 1814240: move mach pastebin description to docstring r=ahochheiden

The description in the docstring will be shown for
`mach help pastebin`, and the shorter description in
the command decorator will be shown in the list of
useful mach commands.

Differential Revision: https://phabricator.services.mozilla.com/D168466
This commit is contained in:
Connor Sheehan 2023-02-01 17:36:01 +00:00
Родитель 6e992536ac
Коммит e0656d7178
1 изменённых файлов: 13 добавлений и 10 удалений

Просмотреть файл

@ -218,17 +218,12 @@ PASTEMO_MAX_CONTENT_LENGTH = 250 * 1024 * 1024
PASTEMO_URL = "https://paste.mozilla.org/api/" PASTEMO_URL = "https://paste.mozilla.org/api/"
MACH_PASTEBIN_DESCRIPTION = """
Command line interface to paste.mozilla.org.
Takes either a filename whose content should be pasted, or reads @Command(
content from standard input. If a highlighter is specified it will "pastebin",
be used, otherwise the file name will be used to determine an category="misc",
appropriate highlighter. description="Command line interface to paste.mozilla.org.",
""" )
@Command("pastebin", category="misc", description=MACH_PASTEBIN_DESCRIPTION)
@CommandArgument( @CommandArgument(
"--list-highlighters", "--list-highlighters",
action="store_true", action="store_true",
@ -255,6 +250,14 @@ appropriate highlighter.
help="Path to file for upload to paste.mozilla.org", help="Path to file for upload to paste.mozilla.org",
) )
def pastebin(command_context, list_highlighters, highlighter, expires, verbose, path): def pastebin(command_context, list_highlighters, highlighter, expires, verbose, path):
"""Command line interface to `paste.mozilla.org`.
Takes either a filename whose content should be pasted, or reads
content from standard input. If a highlighter is specified it will
be used, otherwise the file name will be used to determine an
appropriate highlighter.
"""
import requests import requests
def verbose_print(*args, **kwargs): def verbose_print(*args, **kwargs):