From 8c9f247f24386ec19628094e8dc042b7cc78bf37 Mon Sep 17 00:00:00 2001
From: Victor Lin <13424970+victorlin@users.noreply.github.com>
Date: Mon, 6 May 2024 14:46:14 -0700
Subject: [PATCH] Add docstring to print_err

Clarify when this function should be used.
---
 augur/io/print.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/augur/io/print.py b/augur/io/print.py
index aff911db6..6ba31aab5 100644
--- a/augur/io/print.py
+++ b/augur/io/print.py
@@ -2,4 +2,6 @@
 
 
 def print_err(*args):
+    """Print to stderr. When data goes to stdout (most cases), this should be
+    used for any informational messages, not just errors/warnings."""
     print(*args, file=sys.stderr)