Update docstring for the callback argument (OpenNMT#1313)

guillaumekln · web-flow · commit f600eb6f850a · 2023-06-23T14:10:33.000+02:00
diff --git a/python/cpp/generator.cc b/python/cpp/generator.cc
@@ -254,8 +254,9 @@ namespace ctranslate2 {
                    sampling_topp: Keep the most probable tokens whose cumulative probability exceeds
                      this value.
                    sampling_temperature: Sampling temperature to generate more random samples.
-                   callback: Optional function that is called for each generated token.
-                     This requires a beam size of 1.
+                   callback: Optional function that is called for each generated token when
+                     :obj:`beam_size` is 1. If the callback function returns ``True``, the
+                     decoding will stop for this batch.
 
                  Returns:
                    A list of generation results.
diff --git a/python/cpp/translator.cc b/python/cpp/translator.cc
@@ -490,8 +490,9 @@ namespace ctranslate2 {
                      this value.
                    sampling_temperature: Sampling temperature to generate more random samples.
                    replace_unknowns: Replace unknown target tokens by the source token with the highest attention.
-                   callback: Optional function that is called for each generated token.
-                     This requires a beam size of 1.
+                   callback: Optional function that is called for each generated token when
+                     :obj:`beam_size` is 1. If the callback function returns ``True``, the
+                     decoding will stop for this batch.
 
                  Returns:
                    A list of translation results.
