Skip to content

Commit

Permalink
Add Returns section to the doc for GT.fmt_image() and `GT.fmt_nan…
Browse files Browse the repository at this point in the history
…oplot()`
  • Loading branch information
jrycw committed Sep 17, 2024
1 parent a5bab23 commit e91bbaa
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions great_tables/_formats.py
Original file line number Diff line number Diff line change
Expand Up @@ -3428,6 +3428,12 @@ def fmt_image(
The option to always use Base64 encoding for image paths that are determined to be local. By
default, this is `True`.
Returns
-------
GT
The GT object is returned. This is the same object that the method is called on so that we
can facilitate method chaining.
Examples
--------
Using a small portion of `metro` dataset, let's create a new table. We will only include a few
Expand Down Expand Up @@ -3656,6 +3662,12 @@ def fmt_nanoplot(
By using the [`nanoplot_options()`](`great_tables.nanoplot_options`) helper function here,
you can alter the layout and styling of the nanoplots in the new column.
Returns
-------
GT
The GT object is returned. This is the same object that the method is called on so that we
can facilitate method chaining.
Details
-------
Nanoplots try to show individual data with reasonably good visibility. Interactivity is included
Expand Down

0 comments on commit e91bbaa

Please sign in to comment.