Skip to content

Conversation

@snehankekre
Copy link
Contributor

📚 Context

The docstrings for memo and singleton include a note about the experimental nature of the experimental_allow_widgets parameter and how using it may lead to excessive memory usage. This PR moves the note into the parameter description of experimental_allow_widgets.

  • What kind of change does this PR introduce?

    • Bugfix
    • Feature
    • Refactoring
    • Other, please describe: Doc improvement request

🧠 Description of Changes

  • This PR moves the note about the experimental_allow_widgets param from memo and singleton docstrings into the parameter description of experimental_allow_widgets.

  • Note: this PR neither adds nor update any tests as the changes are merely a refactor of docstrings.

    • This is a breaking API change
    • This is a visible (user-facing) change
Revised:

image

Current:

image

🧪 Testing Done

  • [s] Screenshots included
  • Added/Updated unit tests
  • Added/Updated e2e tests

🌐 References

Does this depend on other work, documents, or tickets?

  • Issue: Closes #XXXX

Contribution License Agreement

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

@snehankekre snehankekre added the security-assessment-completed Security assessment has been completed for PR label Dec 12, 2022
@sfc-gh-tszerszen sfc-gh-tszerszen self-requested a review December 12, 2022 10:43
Copy link
Contributor

@sfc-gh-tszerszen sfc-gh-tszerszen left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@snehankekre
Copy link
Contributor Author

Thanks @sfc-gh-tszerszen! Could you help me merge this PR too? Along with #5831. I don't have merge permissions.

@lukasmasuch lukasmasuch merged commit 10ae0d6 into streamlit:develop Dec 12, 2022
@snehankekre snehankekre deleted the experimental_allow_widgets-note branch December 12, 2022 11:55
tconkling added a commit that referenced this pull request Dec 20, 2022
* develop:
  Change workers balancing logic for e2e tests to always cover all specs (#5865)
  Up version to 1.16.0 (#5852)
  Stop installing pip-tools (#5854)
  Add eslint no relative import paths plugin to pre commit hooks (#5839)
  Docs: move note to `experimental_allow_widgets` param description (#5843)
  Update element docstrings for colored text support (#5831)
  Add remark-directive plugin (Support for colored text in markdown) (#5774)
  Teach WebsocketConnection how to wait on an external auth token (#5728)
  Turn on streamlit theme for altair and plotly (#5796)
  Fix markdown headers spacing (#5829)
  Update error message and docstring in st.map (#5792)
  Remove unnecessarily methods from DeltaGenerator (#5824)
  Resolve vega-tooltip to later version (#5825)
  Easter Egg (#5817)
  Update Exception Layout to avoid overflow (#5700)
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.

3 participants