search

pcdshub / hutch-python

Launcher and config reader for LCLS interactive IPython sessions
https://pcdshub.github.io/hutch-python/
Other
0 stars 18 forks source link

DOC: Add some documentation summarizing the helpful namespaces #344

Open tangkong opened 2 years ago

tangkong commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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