Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Selectbox key argument purpose is unclear #635

Open
rq-aszasz opened this issue May 3, 2023 · 3 comments
Open

Selectbox key argument purpose is unclear #635

rq-aszasz opened this issue May 3, 2023 · 3 comments
Assignees
Labels

Comments

@rq-aszasz
Copy link

Link to doc page in question (if any):
https://github.com/streamlit/docs/blob/main/content/library/api/widgets/selectbox.md

Name of the Streamlit feature whose docs need improvement:
Selectbox

What you think the docs should say:
It is not clear how the key argument is useful. When would one use it and why?
Please include an example.

@MathCatsAnd
Copy link
Contributor

I've written an extended explanation of how widgets work, including the purpose of keys. #643

If that draft is approved (or some version of it), would it make sense to link to the explanation about keys from each widget's docstring re: the key parameter since it is more involved to describe than what would fit nicely there...

@rq-aszasz
Copy link
Author

I support your proposal @MathCatsAnd, thanks!

@sfc-gh-dmatthews sfc-gh-dmatthews self-assigned this Sep 28, 2023
@sfc-gh-dmatthews
Copy link
Contributor

The page about widbet behavior has been published and includes an explanation on keys. Remaining todo is to review the description given for keys and include a helpful link. This may relate to building a list of standard parameters that are shared across functions which is also planned, so I'll leave this open until I circle around to that.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants