pcdshub / pcdshub/engineering_tools
Script helper for making README entries with literal spacing from help text
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 36
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 3
Description
The readme table in this repo is kind of tough to get the formatting correct in, it normally removes all extra spacing giving strange looking results.
In ioc-deploy I found a reasonably simple way to create a text blob that would format as a literal in the html table, and I did it manually for a while before writing a small helper for it , print_help_text_for_readme.
The idea of this ticket would be something like
ioc-deploy --help | readme-ify
I think using help text output in general for the readme is really common even if not everything uses argparse
Originally posted by @ZLLentz in https://github.com/pcdshub/engineering_tools/pull/195#discussion_r1747542006
Contributor guide
No contributing guide indexed for this repository
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 existing print_help_text_for_readme helper and the repository's script entry points, then inspect how help output is currently formatted for README tables. Try the proposed ioc-deploy --help | readme-ify workflow; done means help text preserves literal spacing when emitted for README use.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100