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

Script helper for making README entries with literal spacing from help text #198

Open
ZLLentz opened this issue Sep 6, 2024 · 0 comments

Comments

@ZLLentz
Copy link
Member

ZLLentz commented Sep 6, 2024

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 #195 (comment)

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

1 participant