Skip to content

Conversation

@MathCatsAnd
Copy link
Contributor

📚 Context

There is an orphaned line within the examples in the st.dataframe docstring. A standalone line, not associated to an explanation on syntax or an example reads:

  >>> st.dataframe(df, 200, 100)

The orphaned line appears to have existed since the file was created/renamed.

  • What kind of change does this PR introduce?
    • Documentation

🧠 Description of Changes

The orphaned line is removed from the docstring.

🌐 References


Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.

There was an orphaned line among the examples of the `st.dataframe` docsting. This commit removes it. Git blame shows that it has been orphaned since the file was created under its current name.
@lukasmasuch lukasmasuch added the security-assessment-completed Security assessment has been completed for PR label May 23, 2023
@lukasmasuch lukasmasuch requested a review from snehankekre May 23, 2023 11:31
Copy link
Collaborator

@lukasmasuch lukasmasuch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍 I will wait for @snehankekre to give a final approval before merging

Copy link
Contributor

@snehankekre snehankekre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks again @MathCatsAnd!

@lukasmasuch lukasmasuch merged commit 978edf2 into streamlit:develop May 23, 2023
@MathCatsAnd MathCatsAnd deleted the dataframe-docstring branch May 23, 2023 14:30
tconkling added a commit to tconkling/streamlit that referenced this pull request May 30, 2023
* develop: (22 commits)
  enzyme -> react-testing-library (Countdown, Modal, ProgressBar) (streamlit#6744)
  Remove console.log (streamlit#6753)
  Update `st.data_editor` and `st.dataframe` docstrings (streamlit#6752)
  Update `st.data_editor` session state format (streamlit#6711)
  Cypress flaky test fixes (streamlit#6743)
  Document integer size limit for number_input and slider (streamlit#6724)
  Change default theme hash on app init (streamlit#6729)
  Use .genericFonts instead of .fonts to fix bug with theme postMessage. (streamlit#6732)
  Improve startup performance by lazy loading some dependencies (streamlit#6531)
  Add support for Altair 5 (streamlit#6618)
  Update modals (streamlit#6688)
  Improve docstrings for `ttl` and `max_entries` (streamlit#6733)
  Improve `st.columns` docstring (streamlit#6727)
  Removed orphan line in dataframe docstring (streamlit#6734)
  Fix useIsOverflowing dependency array (streamlit#6731)
  Remove experimental from data editor (streamlit#6712)
  Clarify set_page_config docstring and exception message (streamlit#6594)
  Add a config option to disable warning for setting both a widget default and its key in session_state (streamlit#6640)
  Add column configuration API for `st.dataframe` and `st.data_editor` (streamlit#6598)
  Migrate datetime column formatting from date-fns to momentJS (streamlit#6702)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

security-assessment-completed Security assessment has been completed for PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

An example in st.dataframe docs is missing

3 participants