Skip to content

Docs for st.link_button#14452

Merged
lukasmasuch merged 2 commits intostreamlit:developfrom
MathCatsAnd:docs-link-button-widget
Mar 23, 2026
Merged

Docs for st.link_button#14452
lukasmasuch merged 2 commits intostreamlit:developfrom
MathCatsAnd:docs-link-button-widget

Conversation

@MathCatsAnd
Copy link
Copy Markdown
Contributor

@MathCatsAnd MathCatsAnd commented Mar 22, 2026

Describe your changes

Docs only.

Consistency:

  • Update the key description for completeness and consistency with the latest pattern.
  • Update on_click for consistency with other sometimes-widget elements, emphasizing the change in return value, too.
  • Update the Return value for consistency: Historically, product has decided not to surface DeltaGenerator in the docs. So (per my latest understanding), we brush over that with the concept of "element" until we get a user-friendly subclass or rename for DeltaGenerator.

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

Copilot AI review requested due to automatic review settings March 22, 2026 03:33
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 22, 2026

Thanks for contributing to Streamlit! 🎈

Please make sure you have read our Contributing Guide. You can find additional information about Streamlit development in the wiki.

The review process:

  1. Initial triage: A maintainer will apply labels, approve CI to run, and trigger AI-assisted reviews. Your PR may be flagged with status:needs-product-approval if the feature requires product team sign-off.

  2. Code review: A core maintainer will start reviewing your PR once:

    • It is marked as 'ready for review', not 'draft'
    • It has status:product-approved (or doesn't need it)
    • All CI checks pass
    • All AI review comments are addressed

We're receiving many contributions and have limited review bandwidth — please expect some delay. We appreciate your patience! 🙏

@snyk-io
Copy link
Copy Markdown
Contributor

snyk-io bot commented Mar 22, 2026 •
edited
Loading

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Copilot AI reviewed Mar 22, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the docstring for st.link_button to better align parameter and return-value documentation with current Streamlit documentation patterns, especially for elements that can optionally behave like widgets.

Changes:

  • Expanded key parameter documentation to the newer “stable identity / Session State / CSS class” pattern.
  • Reworded on_click, args, and kwargs docs to clarify widget-like behavior and callback handling.
  • Updated the documented return type to avoid surfacing DeltaGenerator, using the “element” placeholder terminology instead.

lukasmasuch
lukasmasuch approved these changes Mar 22, 2026
View reviewed changes
Copy link
Copy Markdown
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 👍

@lukasmasuch lukasmasuch added type:docs Requests for changes to docs (will be rerouted to docs repo) impact:users PR changes affect end users change:docs PR contains documentation change and removed type:docs Requests for changes to docs (will be rerouted to docs repo) labels Mar 22, 2026
@lukasmasuch lukasmasuch enabled auto-merge (squash) March 23, 2026 10:30
@lukasmasuch lukasmasuch merged commit 8660073 into streamlit:develop Mar 23, 2026
74 of 77 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@lukasmasuch lukasmasuch lukasmasuch approved these changes

Assignees

No one assigned

Labels

change:docs PR contains documentation change impact:users PR changes affect end users

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@MathCatsAnd @lukasmasuch