Skip to content

Commit ed0b9cb

Browse files
Update streamlit.json (#1138)
1 parent d21d4ab commit ed0b9cb

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

python/streamlit.json

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -154932,7 +154932,7 @@
154932154932
},
154933154933
"streamlit.code": {
154934154934
"name": "code",
154935-
"signature": "st.code(body, language=\"python\", line_numbers=False)",
154935+
"signature": "st.code(body, language=\"python\", *, line_numbers=False, wrap_lines=False)",
154936154936
"example": "<blockquote>\n<pre class=\"doctest-block\">\nimport streamlit as st\n\ncode = '''def hello():\n print(&quot;Hello, Streamlit!&quot;)'''\nst.code(code, language=&quot;python&quot;)\n</pre>\n</blockquote>\n",
154937154937
"description": "<p>Display a code block with optional syntax highlighting.</p>\n",
154938154938
"args": [
@@ -154956,9 +154956,17 @@
154956154956
"name": "line_numbers",
154957154957
"type_name": "bool",
154958154958
"is_optional": false,
154959-
"is_kwarg_only": false,
154959+
"is_kwarg_only": true,
154960154960
"description": "<p>An optional boolean indicating whether to show line numbers to the\nleft of the code block. Defaults to <tt class=\"docutils literal\">False</tt>.</p>\n",
154961154961
"default": "s"
154962+
},
154963+
{
154964+
"name": "wrap_lines",
154965+
"type_name": "bool",
154966+
"is_optional": false,
154967+
"is_kwarg_only": true,
154968+
"description": "<p>An optional boolean indicating whether to wrap lines. Defaults\nto <tt class=\"docutils literal\">False</tt>.</p>\n",
154969+
"default": "s"
154962154970
}
154963154971
],
154964154972
"returns": [],
@@ -156200,7 +156208,7 @@
156200156208
},
156201156209
"streamlit.help": {
156202156210
"name": "help",
156203-
"signature": "st.help(obj=<module 'streamlit' from '/Users/dmatthews/Documents/GitHub/streamlit/lib/streamlit/__init__.py'>)",
156211+
"signature": "st.help(obj=<module 'streamlit' from '/Users/dmatthews/anaconda3/envs/latest/lib/python3.11/site-packages/streamlit/__init__.py'>)",
156204156212
"example": "<blockquote>\n<p>Don't remember how to initialize a dataframe? Try this:</p>\n<pre class=\"doctest-block\">\nimport streamlit as st\nimport pandas\n\nst.help(pandas.DataFrame)\n</pre>\n<Cloud name=\"doc-string\" path=\"\" query=\"\" stylePlaceholder=\"height: 700px\" /><p>Want to quickly check what data type is output by a certain function?\nTry:</p>\n<pre class=\"doctest-block\">\nimport streamlit as st\n\nx = my_poorly_documented_function()\nst.help(x)\n</pre>\n<p>Want to quickly inspect an object? No sweat:</p>\n<pre class=\"doctest-block\">\nclass Dog:\n '''A typical dog.'''\n\n def __init__(self, breed, color):\n self.breed = breed\n self.color = color\n\n def bark(self):\n return 'Woof!'\n\n\nfido = Dog(&quot;poodle&quot;, &quot;white&quot;)\n\nst.help(fido)\n</pre>\n<Cloud name=\"doc-string1\" path=\"\" query=\"\" stylePlaceholder=\"height: 300px\" /><p>And if you're using Magic, you can get help for functions, classes,\nand modules without even typing <tt class=\"docutils literal\">st.help</tt>:</p>\n<pre class=\"doctest-block\">\nimport streamlit as st\nimport pandas\n\n# Get help for Pandas read_csv:\npandas.read_csv\n\n# Get help for Streamlit itself:\nst\n</pre>\n<Cloud name=\"doc-string2\" path=\"\" query=\"\" stylePlaceholder=\"height: 700px\" /></blockquote>\n",
156205156213
"description": "<p>Display help and other information for a given object.</p>\n<p>Depending on the type of object that is passed in, this displays the\nobject's name, type, value, signature, docstring, and member variables,\nmethods \u2014 as well as the values/docstring of members and methods.</p>\n",
156206156214
"args": [
@@ -156729,7 +156737,7 @@
156729156737
"type_name": "Iterable",
156730156738
"is_optional": false,
156731156739
"is_kwarg_only": false,
156732-
"description": "<p>Labels for the select options in an Iterable. This can be a\n<tt class=\"docutils literal\">list</tt>, <tt class=\"docutils literal\">set</tt>, or anything supported by <tt class=\"docutils literal\">st.dataframe</tt>. If\n<tt class=\"docutils literal\">options</tt> is dataframe-like, the first column will be used. Each\nlabel will be cast to <tt class=\"docutils literal\">str</tt> internally by default.</p>\n",
156740+
"description": "<p>Labels for the select options in an <tt class=\"docutils literal\">Iterable</tt>. This can be a\n<tt class=\"docutils literal\">list</tt>, <tt class=\"docutils literal\">set</tt>, or anything supported by <tt class=\"docutils literal\">st.dataframe</tt>. If\n<tt class=\"docutils literal\">options</tt> is dataframe-like, the first column will be used. Each\nlabel will be cast to <tt class=\"docutils literal\">str</tt> internally by default.</p>\n",
156733156741
"default": null
156734156742
},
156735156743
{
@@ -157279,7 +157287,7 @@
157279157287
"type_name": "Iterable",
157280157288
"is_optional": false,
157281157289
"is_kwarg_only": false,
157282-
"description": "<p>Labels for the select options in an Iterable. This can be a\n<tt class=\"docutils literal\">list</tt>, <tt class=\"docutils literal\">set</tt>, or anything supported by <tt class=\"docutils literal\">st.dataframe</tt>. If\n<tt class=\"docutils literal\">options</tt> is dataframe-like, the first column will be used. Each\nlabel will be cast to <tt class=\"docutils literal\">str</tt> internally by default.</p>\n<p>Labels can include markdown as described in the <tt class=\"docutils literal\">label</tt> parameter\nand will be cast to str internally by default.</p>\n",
157290+
"description": "<p>Labels for the select options in an <tt class=\"docutils literal\">Iterable</tt>. This can be a\n<tt class=\"docutils literal\">list</tt>, <tt class=\"docutils literal\">set</tt>, or anything supported by <tt class=\"docutils literal\">st.dataframe</tt>. If\n<tt class=\"docutils literal\">options</tt> is dataframe-like, the first column will be used. Each\nlabel will be cast to <tt class=\"docutils literal\">str</tt> internally by default.</p>\n<p>Labels can include markdown as described in the <tt class=\"docutils literal\">label</tt> parameter\nand will be cast to str internally by default.</p>\n",
157283157291
"default": null
157284157292
},
157285157293
{
@@ -157507,7 +157515,7 @@
157507157515
"type_name": "Iterable",
157508157516
"is_optional": false,
157509157517
"is_kwarg_only": false,
157510-
"description": "<p>Labels for the select options in an Iterable. This can be a\n<tt class=\"docutils literal\">list</tt>, <tt class=\"docutils literal\">set</tt>, or anything supported by <tt class=\"docutils literal\">st.dataframe</tt>. If\n<tt class=\"docutils literal\">options</tt> is dataframe-like, the first column will be used. Each\nlabel will be cast to <tt class=\"docutils literal\">str</tt> internally by default.</p>\n",
157518+
"description": "<p>Labels for the select options in an <tt class=\"docutils literal\">Iterable</tt>. This can be a\n<tt class=\"docutils literal\">list</tt>, <tt class=\"docutils literal\">set</tt>, or anything supported by <tt class=\"docutils literal\">st.dataframe</tt>. If\n<tt class=\"docutils literal\">options</tt> is dataframe-like, the first column will be used. Each\nlabel will be cast to <tt class=\"docutils literal\">str</tt> internally by default.</p>\n",
157511157519
"default": null
157512157520
},
157513157521
{
@@ -157612,7 +157620,7 @@
157612157620
"type_name": "Iterable",
157613157621
"is_optional": false,
157614157622
"is_kwarg_only": false,
157615-
"description": "<p>Labels for the select options in an Iterable. This can be a\n<tt class=\"docutils literal\">list</tt>, <tt class=\"docutils literal\">set</tt>, or anything supported by <tt class=\"docutils literal\">st.dataframe</tt>. If\n<tt class=\"docutils literal\">options</tt> is dataframe-like, the first column will be used. Each\nlabel will be cast to <tt class=\"docutils literal\">str</tt> internally by default.</p>\n",
157623+
"description": "<p>Labels for the select options in an <tt class=\"docutils literal\">Iterable</tt>. This can be a\n<tt class=\"docutils literal\">list</tt>, <tt class=\"docutils literal\">set</tt>, or anything supported by <tt class=\"docutils literal\">st.dataframe</tt>. If\n<tt class=\"docutils literal\">options</tt> is dataframe-like, the first column will be used. Each\nlabel will be cast to <tt class=\"docutils literal\">str</tt> internally by default.</p>\n",
157616157624
"default": null
157617157625
},
157618157626
{

0 commit comments

Comments
 (0)