tableau#1464 - docs update for filtering on boolean values (tableau#1471)

jacalata · web-flow · commit 9a310040c8d9 · 2024-09-28T11:32:20.000-07:00
Add docs mention of boolean values for filtering
diff --git a/tableauserverclient/server/request_options.py b/tableauserverclient/server/request_options.py
@@ -164,13 +164,14 @@ def get_query_params(self):
         raise NotImplementedError()
 
     def vf(self, name: str, value: str) -> Self:
-        """Apply a filter to the view for a filter that is a normal column
-        within the view."""
+        """Apply a filter based on a column within the view.
+        Note that when filtering on a boolean type field, the only valid values are 'true' and 'false'"""
         self.view_filters.append((name, value))
         return self
 
     def parameter(self, name: str, value: str) -> Self:
-        """Apply a filter based on a parameter within the workbook."""
+        """Apply a filter based on a parameter within the workbook.
+        Note that when filtering on a boolean type field, the only valid values are 'true' and 'false'"""
         self.view_parameters.append((name, value))
         return self
 
