docs: add documentation in metrics.py

openfoodfacts · Mar 12, 2023 · 0ce2b0e · 0ce2b0e
1 parent 1cd9866
commit 0ce2b0e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/robotoff/metrics.py b/robotoff/metrics.py
@@ -98,6 +98,11 @@ def ensure_influx_database():
 
 
 def get_product_count(country_tag: str) -> int:
+    """Return the number of products in Product Opener for a specific country.
+
+    :param country_tag: ISO 2-letter country code
+    :return: the number of products currently in Product Opener
+    """
     r = http_session.get(
         settings.BaseURLProvider.country(country_tag) + "/3.json?fields=null",
         auth=settings._off_request_auth,