|
280 | 280 |
|
281 | 281 | engine_kwargs : dict, optional
|
282 | 282 | Arbitrary keyword arguments passed to excel engine.
|
283 |
| - |
| 283 | +
|
284 | 284 | notes: DataFrame, default None
|
285 | 285 | A DataFrame to hold the notes extracted from the Excel file.
|
286 | 286 |
|
|
358 | 358 | 2 None NaN
|
359 | 359 |
|
360 | 360 | To get the comments of the excel input file, pass a ``notes`` DataFrame.
|
361 |
| -This new DataFrame might have different dimensions than the data returned |
362 |
| -DataFrame since it'll only read the columns which cells have notes. |
363 |
| -(last column with note - first column with note + 1) * |
| 361 | +This DataFrame might have different dimensions than the returned DataFrame |
| 362 | +by ``read_excel`` since it'll only read the cells with notes. This DataFrame |
| 363 | +dimensions will be: (last column with note - first column with note + 1) * |
364 | 364 | (last row with note - first row with note + 1).
|
365 | 365 |
|
366 |
| -Cells with no notes will have an empty string (""). |
| 366 | +Cells with no notes inside these limits will have an empty string (""). |
367 | 367 |
|
368 | 368 | If the data in the ``tmp.xlsx`` file was written using the
|
369 | 369 | ``set_tooltips(notes)`` method of ``Styler.to_excel``, like in
|
|
377 | 377 |
|
378 | 378 | >>> df_notes = pd.DataFrame() # doctest: +SKIP
|
379 | 379 |
|
380 |
| ->>> pd.read_excel('tmp.xlsx', df_notes) # doctest: +SKIP |
| 380 | +>>> pd.read_excel('tmp.xlsx', notes=df_notes) # doctest: +SKIP |
381 | 381 | Name Value
|
382 | 382 | 0 string1 1
|
383 | 383 | 1 string2 2
|
@@ -625,7 +625,9 @@ def get_sheet_by_name(self, name: str):
|
625 | 625 | def get_sheet_by_index(self, index: int):
|
626 | 626 | raise NotImplementedError
|
627 | 627 |
|
628 |
| - def get_sheet_data(self, sheet, rows: int | None = None, notes: DataFrame | None = None): |
| 628 | + def get_sheet_data( |
| 629 | + self, sheet, rows: int | None = None, notes: DataFrame | None = None |
| 630 | + ): |
629 | 631 | raise NotImplementedError
|
630 | 632 |
|
631 | 633 | def raise_if_bad_sheet_by_index(self, index: int) -> None:
|
|
0 commit comments