Add pr_status help about GITHUB_TOKEN

acsone · Jan 25, 2023 · d7b08cd · d7b08cd
1 parent 05b54d2
commit d7b08cd
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/acsoo/pr_status.py b/acsoo/pr_status.py
@@ -59,7 +59,11 @@ def search_prs():
 
 @click.command()
 def pr_status():
-    """Show status of PR found in requirement files."""
+    """Show status of PR found in requirement files.
+
+    If set, the GITHUB_TOKEN environment variable is used to authenticate with the
+    GitHub API and avoid rate limiting.
+    """
     # get github token from env
     token = os.environ.get("GITHUB_TOKEN")
     if token: