Skip to content

Commit

Permalink
Update :formatter option docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kipcole9 committed Jun 11, 2024
1 parent 9d9257e commit 40d7468
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions lib/kino/data_table.ex
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,9 @@ defmodule Kino.DataTable do
* `:formatter` - a 2-arity function that is used to format the data
in the table. The first parameter passed is the `key` (column name) and
the second is the value to be formatted. When formatting column headings
the key is the special value `:__header__`. Defaults to the builtin
formatter.
the key is the special value `:__header__`. The formatter function must
return either `{:ok, string}` or `:default`. When the return value is
`:default` the default data table formatting is applied.
"""
@spec new(Table.Reader.t(), keyword()) :: t()
Expand Down

0 comments on commit 40d7468

Please sign in to comment.