docs: correct README facts and document CLI options - #148
Merged
Merged
Conversation
- Move profiles out of supported composition into an accepted-and-ignored list - Quote 'compose2pod[yaml]' in README and the missing-extra error so zsh accepts it - Add help text for --pod-name and --format and document every CLI option - Plain bullets, no dashes, shorter Requirements and conformance prose
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
README facts that did not match the code, two small CLI fixes found alongside, and prose cleanup.
Changes
profileswas listed under supported composition, but it is inIGNORED_SERVICE_KEYS(compose2pod/parsing.py:44-53) and only produces an "ignoring" warning (parsing.py:832-834); nothing else reads it, so every service runs regardless of profile. Moved it to a new "accepted and ignored with a warning" line with the other keys from that dict:ports,expose,restart,stdin_open,tty,stop_signal,stop_grace_period.pip install compose2pod[yaml]is a glob in zsh and fails. Quoted it in the README and in the missing-extra error (compose2pod/read.py:73); the CLI test now asserts the quoted form (written failing first).--pod-nameand--formathad no argparse help (compose2pod/cli.py:24-25). Added help strings (pod name is also the container name prefix,emit.py:154;autotries JSON then YAML,read.py:91), with a test on--helpoutput written failing first. The README now lists every CLI option.Checklist
ruff)ty)uv build) if packaging or build config changeddescription, profile blurb) if this touches packaging