pcdshub / pcdshub/hutch-python
DOC: Add some documentation summarizing the helpful namespaces
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1
- Forks
- 18
- Avg merge
- 7d 9h
- Merged PRs (30d)
- 1
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the startup banner code that currently reports initialized namespaces and the existing documentation structure. Use the banner output to identify the namespaces and explain them on a new documentation page. Done means users have a quick documentation link that lists and describes the helpful hutch-python namespaces.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100