Improve the docstrings of the validate_output_table_type function (#3832)

Author: seisman

pygmt/helpers/validators.py

@@ -17,16 +17,15 @@ def validate_output_table_type(
     Parameters
     ----------
     output_type
-        Desired output type of tabular data. Valid values are ``"pandas"``,
-        ``"numpy"`` and ``"file"``.
+        Desired output type of tabular data. Valid values are ``"pandas"``, ``"numpy"``,
+        and ``"file"``.
     outfile
         File name for saving the result data. Required if ``output_type`` is ``"file"``.
         If specified, ``output_type`` will be forced to be ``"file"``.
 
     Returns
     -------
-    str
-        The original or updated output type.
+    The original or updated output type.
 
     Examples
     --------
@@ -57,9 +56,8 @@ def validate_output_table_type(
         raise GMTInvalidInput(msg)
     if output_type != "file" and outfile is not None:
         msg = (
-            f"Changing 'output_type' from '{output_type}' to 'file' "
-            "since 'outfile' parameter is set. Please use output_type='file' "
-            "to silence this warning."
+            f"Changing 'output_type' from '{output_type}' to 'file' since 'outfile' "
+            "parameter is set. Please use output_type='file' to suppress the warning."
         )
         warnings.warn(message=msg, category=RuntimeWarning, stacklevel=2)
         output_type = "file"