DOC: document paths for get-info-json tool
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2
- Forks
- 6
- Avg merge
- 7d 11h
- Merged PRs (30d)
- 1
Description
I'm not sure the meaning behind these paths; investigate and document them:
DATA_PATH = "/cds/group/psdm/"
Both exist, group/psdm is where code lives. data/psdm is where data lives. I'd have to check what this is used for
Originally posted by @silkenelson in https://github.com/pcdshub/pcdsutils/pull/51#discussion_r918251282
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 get-info-json tool and its DATA_PATH definition, then trace how the listed paths are used. Document the meaning and distinction between /cds/group/psdm/ and data/psdm, with the work complete when their roles are clear to users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100