From a8f0ca81a0903ed2f037f20a86d1db7e2a379475 Mon Sep 17 00:00:00 2001
From: Carmen Bianca BAKKER <carmenbianca@fsfe.org>
Date: Sun, 13 Oct 2024 14:37:02 +0200
Subject: [PATCH] Provide helpful comment to translators

Signed-off-by: Carmen Bianca BAKKER <carmenbianca@fsfe.org>
---
 src/reuse/cli/annotate.py  | 6 ++++++
 src/reuse/cli/download.py  | 1 +
 src/reuse/cli/lint_file.py | 1 +
 3 files changed, 8 insertions(+)

diff --git a/src/reuse/cli/annotate.py b/src/reuse/cli/annotate.py
index c803e334..4d3dd390 100644
--- a/src/reuse/cli/annotate.py
+++ b/src/reuse/cli/annotate.py
@@ -290,6 +290,7 @@ def get_reuse_info(
     "--copyright",
     "-c",
     "copyrights",
+    # TRANSLATORS: You may translate this. Please preserve capital letters.
     metavar=_("COPYRIGHT"),
     type=str,
     multiple=True,
@@ -299,6 +300,7 @@ def get_reuse_info(
     "--license",
     "-l",
     "licenses",
+    # TRANSLATORS: You may translate this. Please preserve capital letters.
     metavar=_("SPDX_IDENTIFIER"),
     type=spdx_identifier,
     multiple=True,
@@ -307,6 +309,7 @@ def get_reuse_info(
 @click.option(
     "--contributor",
     "contributors",
+    # TRANSLATORS: You may translate this. Please preserve capital letters.
     metavar=_("CONTRIBUTOR"),
     type=str,
     multiple=True,
@@ -316,6 +319,7 @@ def get_reuse_info(
     "--year",
     "-y",
     "years",
+    # TRANSLATORS: You may translate this. Please preserve capital letters.
     metavar=_("YEAR"),
     cls=MutexOption,
     mutually_exclusive=_YEAR_MUTEX,
@@ -346,6 +350,7 @@ def get_reuse_info(
     "--template",
     "-t",
     "template_str",
+    # TRANSLATORS: You may translate this. Please preserve capital letters.
     metavar=_("TEMPLATE"),
     type=str,
     help=_("Name of template to use."),
@@ -421,6 +426,7 @@ def get_reuse_info(
 )
 @click.argument(
     "paths",
+    # TRANSLATORS: You may translate this. Please preserve capital letters.
     metavar=_("PATH"),
     type=click.Path(exists=True, writable=True, path_type=Path),
     nargs=-1,
diff --git a/src/reuse/cli/download.py b/src/reuse/cli/download.py
index b217eb78..a1e0256b 100644
--- a/src/reuse/cli/download.py
+++ b/src/reuse/cli/download.py
@@ -139,6 +139,7 @@ def _successfully_downloaded(destination: StrPath) -> None:
 )
 @click.argument(
     "license_",
+    # TRANSLATORS: You may translate this. Please preserve capital letters.
     metavar=_("LICENSE"),
     type=str,
     nargs=-1,
diff --git a/src/reuse/cli/lint_file.py b/src/reuse/cli/lint_file.py
index b8702155..cbd8f75e 100644
--- a/src/reuse/cli/lint_file.py
+++ b/src/reuse/cli/lint_file.py
@@ -47,6 +47,7 @@
 )
 @click.argument(
     "files",
+    # TRANSLATORS: You may translate this. Please preserve capital letters.
     metavar=_("FILE"),
     type=click.Path(exists=True, path_type=Path),
     nargs=-1,