docs: add code sample and docstring for bpd.options.experiments.sql_compiler (#2474)

tswast · web-flow · commit 867951bcabcf · 2026-02-24T12:27:02.000-06:00
Added documentation for the sql_compiler property. Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly: - [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/python-bigquery-dataframes/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea - [ ] Ensure the tests and linter pass - [ ] Code coverage does not decrease (if any source code was changed) - [ ] Appropriate docs were updated (if necessary) Fixes #<issue_number_goes_here> 🦕
diff --git a/bigframes/_config/experiment_options.py b/bigframes/_config/experiment_options.py
@@ -72,6 +72,13 @@ def ai_operators(self, value: bool):
 
     @property
     def sql_compiler(self) -> Literal["legacy", "stable", "experimental"]:
+        """Set to 'experimental' to try out the latest in compilation experiments..
+
+        **Examples:**
+
+            >>> import bigframes.pandas as bpd
+            >>> bpd.options.experiments.sql_compiler = 'experimental'  # doctest: +SKIP
+        """
         return self._sql_compiler
 
     @sql_compiler.setter
