Update st.audio/st.video docstrings #6964
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
snehankekre
approved these changes
Jul 10, 2023
sfc-gh-dmatthews
approved these changes
Jul 10, 2023
|
LGTM, too. No warnings parsing the docstrings. |
tconkling
added a commit
to tconkling/streamlit
that referenced
this pull request
Jul 12, 2023
* develop: Feature: st.toast (streamlit#6783) Bump semver from 5.7.1 to 5.7.2 in /frontend (streamlit#6982) Add host communication e2e tests (streamlit#6806) Re-add homepage to package.json (streamlit#6987) Remove unnecessary code and Add rm commands to make clean (streamlit#6980) Allow setting placeholder for st.selectbox (streamlit#6913) Allow setting placeholder for st.multiselect (streamlit#6901) Also use bottom padding in embedded mode for chat input (streamlit#6979) Feature/st lib (streamlit#6692) Remove unused import (streamlit#6977) Release 1.24.1 (streamlit#6965) Update st.audio/st.video docstrings (streamlit#6964) Slightly simplify bug report template (streamlit#6972) Fix baseweb warnings by using longhand properties (streamlit#6976)
eric-skydio
pushed a commit
to eric-skydio/streamlit
that referenced
this pull request
Dec 20, 2023
zyxue
pushed a commit
to zyxue/streamlit
that referenced
this pull request
Mar 22, 2024
zyxue
pushed a commit
to zyxue/streamlit
that referenced
this pull request
Apr 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
The API reference for
st.audioandst.videohas a visual bug, where the last part of the type descriptor fordatais added to the description:While trying to fix this, I realized that we should probably just say "..., or file" instead of "..., or file opened with io.open()".
io.open()is just a wrapper around Python's built-inopen()method, and the return objects of this function are commonly described simply as "files" or "file objects", see here.GitHub Issue Link (if applicable)
Testing Plan
Just docstring change, no test needed.
Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.