Merged
Conversation
Contributor
🎉 Snyk checks have passed. No issues have been found so far.✅ security/snyk check is complete. No issues have been found. (View Details) ✅ license/snyk check is complete. No issues have been found. (View Details) |
sfc-gh-dmatthews
added
security-assessment-completed
impact:internal
Contributor
✅ PR preview is ready!
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates docstrings across Streamlit components for version 1.50.0, focusing on improving clarity, consistency, and adding new feature documentation.
Key changes include:
- Repositioned deprecation warnings to appear directly after parameter descriptions for better readability
- Enhanced documentation for MultiselectColumn with expanded color options and usage examples
- Updated various component docstrings with improved formatting and clearer descriptions
Reviewed Changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 18 comments.
Show a summary per file
| File | Description |
|---|---|
| lib/streamlit/elements/widgets/data_editor.py | Moved deprecation warning for use_container_width parameter to follow the parameter description |
| lib/streamlit/elements/widgets/button.py | Repositioned deprecation warnings for all button components (button, download_button, link_button, page_link) |
| lib/streamlit/elements/widgets/audio_input.py | Enhanced sample rate documentation and added new examples for different quality recordings |
| lib/streamlit/elements/vega_charts.py | Updated width/height parameter descriptions and improved bar chart sort documentation |
| lib/streamlit/elements/pyplot.py | Moved deprecation warning after parameter description |
| lib/streamlit/elements/plotly_chart.py | Updated deprecation message format |
| lib/streamlit/elements/lib/column_types.py | Comprehensive updates to column types including width distribution info, enhanced color documentation for chart columns, and expanded MultiselectColumn documentation |
| lib/streamlit/elements/layouts.py | Enhanced tabs documentation with new examples and default parameter clarification |
| lib/streamlit/elements/image.py | Moved deprecation warning for use_column_width parameter |
| lib/streamlit/elements/graphviz_chart.py | Updated height parameter description and moved deprecation warning |
| lib/streamlit/elements/form.py | Moved deprecation warning for form_submit_button |
| lib/streamlit/elements/deck_gl_json_chart.py | Minor formatting fix |
| lib/streamlit/elements/arrow.py | Updated table borders documentation and moved deprecation warning |
| lib/streamlit/config.py | Improved theme color configuration descriptions and added hosted font configuration options |
| lib/streamlit/commands/navigation.py | Added documentation for empty section labels in top navigation |
jrieke
approved these changes
Sep 23, 2025
sfc-gh-dmatthews
force-pushed
the
docs/1.50.0
branch
from
e4cee7b to
704de63
Compare
sfc-gh-dmatthews
force-pushed
the
docs/1.50.0
branch
from
704de63 to
1960e53
Compare
github-actions bot
pushed a commit
that referenced
this pull request
Sep 23, 2025
## Describe your changes Update docstrings for 1.50.0 * MultiselectColumn * Hosted font configuration options * Default st.tabs * Table borders * Vega chart height and width * Graphviz height and width * Basic color palette theming configuration * Bar chart sort parameter * Audio input sample rate * Empty section labels in top navigation * Chart column colors ## GitHub Issue Link (if applicable) ## Testing Plan n/a docstrings only - Explanation of why no additional tests are needed - Unit Tests (JS and/or Python) - E2E Tests - Any manual testing 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.
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
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
Update docstrings for 1.50.0
GitHub Issue Link (if applicable)
Testing Plan
n/a docstrings only
Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.