Display object's doc string, nicely formatted.

Displays the doc string for this object.

Function signature

st.help(obj)

Parameters

obj (Object)

The object whose docstring should be displayed.

Example

Don't remember how to initialize a dataframe? Try this:

import streamlit as st
import pandas

st.help(pandas.DataFrame)

Want to quickly check what datatype is output by a certain function? Try:

import streamlit as st

x = my_poorly_documented_function()
st.help(x)

Was this page helpful?

editSuggest edits
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.