Skip to content

Commit

Permalink
Fix typo in the data frame doc (#1144)
Browse files Browse the repository at this point in the history
  • Loading branch information
whitphx authored Oct 1, 2024
1 parent 5ccfc16 commit 76faf01
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion python/streamlit.json
Original file line number Diff line number Diff line change
Expand Up @@ -155317,7 +155317,7 @@
"type_name": "dataframe-like, collection-like, or None",
"is_optional": false,
"is_kwarg_only": false,
"description": "<p>The data to display.</p>\n<p>Dataframe-like objects include dataframe and series objects from\npopular libraries like Dask, Modin, Numpy, pandas, Polars, PyArrow,\nSnowpark, Xarray, and more. You can use database cursors and\nclients that comply with the\n<a class=\"reference external\" href=\"https://peps.python.org/pep-0249/\">Python Database API Specification v2.0 (PEP 249)</a>. Additionally, you can use\nanything that supports the <a class=\"reference external\" href=\"https://data-apis.org/dataframe-protocol/latest/\">Python dataframe interchange protocol</a>.</p>\n<p>For example, you can use the following:</p>\n<ul class=\"simple\">\n<li><tt class=\"docutils literal\">pandas.DataFrame</tt>, <tt class=\"docutils literal\">pandas.Series</tt>, <tt class=\"docutils literal\">pandas.Index</tt>,\n<tt class=\"docutils literal\">pandas.Styler</tt>, and <tt class=\"docutils literal\">pandas.Array</tt></li>\n<li><tt class=\"docutils literal\">polars.DataFrame</tt>, <tt class=\"docutils literal\">polars.LazyFrame</tt>, and <tt class=\"docutils literal\">polars.Series</tt></li>\n<li><tt class=\"docutils literal\">snowflake.snowpark.dataframe.DataFrame</tt>,\n<tt class=\"docutils literal\">snowflake.snowpark.table.Table</tt></li>\n</ul>\n<p>If a dataype is not recognized, Streamlit will convert the object\nto a <tt class=\"docutils literal\">pandas.DataFrame</tt> or <tt class=\"docutils literal\">pyarrow.Table</tt> using a\n<tt class=\"docutils literal\">.to_pandas()</tt> or <tt class=\"docutils literal\">.to_arrow()</tt> method, respectively, if\navailable.</p>\n<p>If <tt class=\"docutils literal\">data</tt> is a <tt class=\"docutils literal\">pandas.Styler</tt>, it will be used to style its\nunderlying <tt class=\"docutils literal\">pandas.DataFrame</tt>. Streamlit supports custom cell\nvalues and colors. It does not support some of the more exotic\nstyling options, like bar charts, hovering, and captions. For\nthese styling options, use column configuration instead.</p>\n<p>Collection-like objects include all Python-native <tt class=\"docutils literal\">Collection</tt>\ntypes, such as <tt class=\"docutils literal\">dict</tt>, <tt class=\"docutils literal\">list</tt>, and <tt class=\"docutils literal\">set</tt>.</p>\n<p>If <tt class=\"docutils literal\">data</tt> is <tt class=\"docutils literal\">None</tt>, Streamlit renders an empty table.</p>\n",
"description": "<p>The data to display.</p>\n<p>Dataframe-like objects include dataframe and series objects from\npopular libraries like Dask, Modin, Numpy, pandas, Polars, PyArrow,\nSnowpark, Xarray, and more. You can use database cursors and\nclients that comply with the\n<a class=\"reference external\" href=\"https://peps.python.org/pep-0249/\">Python Database API Specification v2.0 (PEP 249)</a>. Additionally, you can use\nanything that supports the <a class=\"reference external\" href=\"https://data-apis.org/dataframe-protocol/latest/\">Python dataframe interchange protocol</a>.</p>\n<p>For example, you can use the following:</p>\n<ul class=\"simple\">\n<li><tt class=\"docutils literal\">pandas.DataFrame</tt>, <tt class=\"docutils literal\">pandas.Series</tt>, <tt class=\"docutils literal\">pandas.Index</tt>,\n<tt class=\"docutils literal\">pandas.Styler</tt>, and <tt class=\"docutils literal\">pandas.Array</tt></li>\n<li><tt class=\"docutils literal\">polars.DataFrame</tt>, <tt class=\"docutils literal\">polars.LazyFrame</tt>, and <tt class=\"docutils literal\">polars.Series</tt></li>\n<li><tt class=\"docutils literal\">snowflake.snowpark.dataframe.DataFrame</tt>,\n<tt class=\"docutils literal\">snowflake.snowpark.table.Table</tt></li>\n</ul>\n<p>If a data type is not recognized, Streamlit will convert the object\nto a <tt class=\"docutils literal\">pandas.DataFrame</tt> or <tt class=\"docutils literal\">pyarrow.Table</tt> using a\n<tt class=\"docutils literal\">.to_pandas()</tt> or <tt class=\"docutils literal\">.to_arrow()</tt> method, respectively, if\navailable.</p>\n<p>If <tt class=\"docutils literal\">data</tt> is a <tt class=\"docutils literal\">pandas.Styler</tt>, it will be used to style its\nunderlying <tt class=\"docutils literal\">pandas.DataFrame</tt>. Streamlit supports custom cell\nvalues and colors. It does not support some of the more exotic\nstyling options, like bar charts, hovering, and captions. For\nthese styling options, use column configuration instead.</p>\n<p>Collection-like objects include all Python-native <tt class=\"docutils literal\">Collection</tt>\ntypes, such as <tt class=\"docutils literal\">dict</tt>, <tt class=\"docutils literal\">list</tt>, and <tt class=\"docutils literal\">set</tt>.</p>\n<p>If <tt class=\"docutils literal\">data</tt> is <tt class=\"docutils literal\">None</tt>, Streamlit renders an empty table.</p>\n",
"default": null
},
{
Expand Down

0 comments on commit 76faf01

Please sign in to comment.