Skip to content

Add missing parameter to st.code #1138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Add missing parameter to st.code #1138

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions python/streamlit.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154932,7 +154932,7 @@
},
"streamlit.code": {
"name": "code",
"signature": "st.code(body, language=\"python\", line_numbers=False)",
"signature": "st.code(body, language=\"python\", *, line_numbers=False, wrap_lines=False)",
"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",
"description": "<p>Display a code block with optional syntax highlighting.</p>\n",
"args": [
Expand All @@ -154956,9 +154956,17 @@
"name": "line_numbers",
"type_name": "bool",
"is_optional": false,
"is_kwarg_only": false,
"is_kwarg_only": true,
"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",
"default": "s"
},
{
"name": "wrap_lines",
"type_name": "bool",
"is_optional": false,
"is_kwarg_only": true,
"description": "<p>An optional boolean indicating whether to wrap lines. Defaults\nto <tt class=\"docutils literal\">False</tt>.</p>\n",
"default": "s"
}
],
"returns": [],
Expand Down Expand Up @@ -156200,7 +156208,7 @@
},
"streamlit.help": {
"name": "help",
"signature": "st.help(obj=<module 'streamlit' from '/Users/dmatthews/Documents/GitHub/streamlit/lib/streamlit/__init__.py'>)",
"signature": "st.help(obj=<module 'streamlit' from '/Users/dmatthews/anaconda3/envs/latest/lib/python3.11/site-packages/streamlit/__init__.py'>)",
"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",
"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",
"args": [
Expand Down Expand Up @@ -156729,7 +156737,7 @@
"type_name": "Iterable",
"is_optional": false,
"is_kwarg_only": false,
"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",
"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",
"default": null
},
{
Expand Down Expand Up @@ -157279,7 +157287,7 @@
"type_name": "Iterable",
"is_optional": false,
"is_kwarg_only": false,
"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",
"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",
"default": null
},
{
Expand Down Expand Up @@ -157507,7 +157515,7 @@
"type_name": "Iterable",
"is_optional": false,
"is_kwarg_only": false,
"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",
"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",
"default": null
},
{
Expand Down Expand Up @@ -157612,7 +157620,7 @@
"type_name": "Iterable",
"is_optional": false,
"is_kwarg_only": false,
"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",
"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",
"default": null
},
{
Expand Down