Skip to content
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

Docs: Invalid link in Contributing Guide for Python unit tests #1191

Closed
davidkrigbaum opened this issue Nov 23, 2024 · 2 comments
Closed

Docs: Invalid link in Contributing Guide for Python unit tests #1191

davidkrigbaum opened this issue Nov 23, 2024 · 2 comments

Comments

@davidkrigbaum
Copy link

davidkrigbaum commented Nov 23, 2024

Link to doc page in question (if any): https://github.com/streamlit/streamlit/wiki/Contributing#python-unit-tests

Name of the Streamlit feature whose docs need improvement: Running tests: Python unit tests

What you think the docs should say:
The Contributing Guidelines specify in a fragment:

Some tests require you to set up credentials to connect to Snowflake and install the snowflake-snowpark-python package

But the link for 'set up credentials' leads to a '404 - page not found'.

The link should be updated to reflect current credentialing instructions or the wiki documentation should outline that information explicitly.

I found a potential link solution here: https://docs.streamlit.io/develop/tutorials/databases/snowflake#add-connection-parameters-to-your-local-app-secrets but am unsure if this is what the dead link is supposed to reference. Please verify if this is the correct reference.

@davidkrigbaum
Copy link
Author

I would like to volunteer to submit a PR to the wiki once the correct link is confirmed.

@sfc-gh-dmatthews
Copy link
Contributor

Hi @davidkrigbaum! Thanks for reporting. I asked an engineer and they went ahead and corrected the section as some additional details changed as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants