From 540d17c953222a742bd93c511f1e14769c175bc8 Mon Sep 17 00:00:00 2001
From: Zachary Lawrence <mail@zacharylawrence.com>
Date: Tue, 20 Apr 2021 12:08:32 -0400
Subject: [PATCH] Clarify extractOne return type

---
 fuzzywuzzy/process.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/fuzzywuzzy/process.py b/fuzzywuzzy/process.py
index 4d73248d..e55d913c 100644
--- a/fuzzywuzzy/process.py
+++ b/fuzzywuzzy/process.py
@@ -214,6 +214,10 @@ def extractOne(query, choices, processor=default_processor, scorer=default_score
     Returns:
         A tuple containing a single match and its score, if a match
         was found that was above score_cutoff. Otherwise, returns None.
+
+        If a list is used for choices, then the result will be 2-tuples.
+        If a dictionary is used, then the result will be 3-tuples containing
+        the key for each match.
     """
     best_list = extractWithoutOrder(query, choices, processor, scorer, score_cutoff)
     try: