DOC: Showcase writing comments in Styler.to_excel() (pandas-dev#58070)

Co-authored-by: diogomsmiranda <[email protected]>

Author: Dacops

pandas/core/generic.py

@@ -2125,6 +2125,7 @@ def _repr_data_resource_(self):
             Arbitrary keyword arguments passed to excel engine.
     """
         ),
+        extra_examples="",
     )
     def to_excel(
         self,
@@ -2256,6 +2257,7 @@ def to_excel(
         automatically chosen depending on the file extension):
 
         >>> df1.to_excel("output1.xlsx", engine="xlsxwriter")  # doctest: +SKIP
+        {extra_examples}
         """
         if engine_kwargs is None:
             engine_kwargs = {}

pandas/io/formats/style.py

@@ -92,6 +92,8 @@
 except ImportError:
     has_mpl = False
 
+import textwrap
+
 
 @contextmanager
 def _mpl(func: Callable) -> Generator[tuple[Any, Any], None, None]:
@@ -555,6 +557,19 @@ def set_tooltips(
         storage_options=_shared_docs["storage_options"],
         storage_options_versionadded="1.5.0",
         extra_parameters="",
+        extra_examples=textwrap.dedent(
+            """\
+        If you wish to write excel notes to the workbook, you can do so by
+        passing a DataFrame to ``set_tooltips``. This process is independent
+        from writing data to the workbook, therefore both DataFrames can have
+        different dimensions.
+
+        >>> notes = pd.DataFrame(
+        ...     [["cell 1", "cell 2"], ["cell 3", "cell 4"]],
+        ... )
+        >>> df1.style.set_tooltips(notes).to_excel("output.xlsx")  # doctest: +SKIP
+    """
+        ),
     )
     def to_excel(
         self,