Skip to content

Update components-api.md #789

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 23, 2023
Merged

Update components-api.md #789

merged 1 commit into from
Aug 23, 2023

Conversation

sfc-gh-pbelczyk
Copy link
Contributor

@sfc-gh-pbelczyk sfc-gh-pbelczyk commented Aug 23, 2023

📚 Context

While working on e2e setup for component-template (streamlit/component-template#68) we extract example to separate file, so command for run example component is now invalid.

🧠 Description of Changes

Change command to run example from: streamlit run my_component/__init__.py to streamlit run my_component/example.py in all places

💥 Impact

Size:

  • Small
  • Not small

🌐 References

Contribution License Agreement

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

While working on e2e setup for component-template (streamlit/component-template#70) we extract example to separate file, so command for run example component is now invalid.
Copy link
Contributor

@snehankekre snehankekre left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @sfc-gh-pbelczyk!

Our team isn't an expert at bi-directional component creation, so we haven't updated the documentation in a while. As you're thinking more about components and e2e testing, if you spot bugs in the docs or have ideas to improve the components api docs, we welcome follow-up PRs and/or discussions! 😄

@snehankekre snehankekre merged commit f95d1fd into main Aug 23, 2023
@snehankekre snehankekre deleted the sfc-gh-pbelczyk-patch-1 branch August 23, 2023 09:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants