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

DOC: Add some documentation summarizing the helpful namespaces #344

Open
tangkong opened this issue Jul 1, 2022 · 2 comments
Open

DOC: Add some documentation summarizing the helpful namespaces #344

tangkong opened this issue Jul 1, 2022 · 2 comments

Comments

@tangkong
Copy link
Contributor

tangkong commented Jul 1, 2022

Expected Behavior

We should have a documentation page that lists/explains the various namespaces that get initialized in hutch-python. Currently we spit some information out in the banner at startup, but maybe we should capture that in the actual documentation as well.

Context

Was helping someone with some hutch-python related things, and didn't have a quick link on hand

Your Environment

pcds-5.4.1

@tangkong
Copy link
Contributor Author

This might also be a good place to notify users when their packages are out of date. Perhaps we color the current environment red if it's out of date? Something additional to let users know that there's a new conda environment out could be helpful

@klauer
Copy link
Contributor

klauer commented Jul 21, 2022

I like that idea: "Your environment is out of date; pcds-vx.y.z is now available. See the release notes here: ..."

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

No branches or pull requests

2 participants