docs(liboci-cli): add missing help descriptions to arguments and options#3456
Open
xvchris wants to merge 2 commits intoyouki-dev:mainfrom
Open
docs(liboci-cli): add missing help descriptions to arguments and options#3456xvchris wants to merge 2 commits intoyouki-dev:mainfrom
xvchris wants to merge 2 commits intoyouki-dev:mainfrom
Conversation
Fixes youki-dev#3454 Several subcommands were missing help text for arguments and options, resulting in blank descriptions in `--help` output. Add `///` doc comments to: - kill: container_id, signal, --all - run: --keep - exec: --tty - pause, resume, start, state, delete, ps, update: container_id Signed-off-by: xvchris <xvchris@gmail.com>
YJDoc2
added
the
kind/cleanup
YJDoc2
reviewed
Mar 17, 2026
Collaborator
YJDoc2
left a comment
YJDoc2
left a comment
There was a problem hiding this comment.
nit: I feel
Container Identifier
would be better than
Identifier of the container
No particular reason, but feels better to me. However, current is also acceptable, open for discussion of the wording.
Apart from that lgtm
Author
|
Good point — updated to 'Container identifier' across all 9 files. Thanks! |
YJDoc2
approved these changes
Mar 18, 2026
Collaborator
YJDoc2
left a comment
YJDoc2
left a comment
There was a problem hiding this comment.
approved, but the last commit was not signed, so dco is missing. Please re sign as per https://github.com/youki-dev/youki/pull/3456/checks?check_run_id=67356689651 , and then we can merge this.
Signed-off-by: xvchris <chrisjh@foxmail.com>
xvchris
force-pushed
the
docs/add-help-descriptions
branch
from
fdbb5f6 to
521f4d5
Compare
Author
|
@YJDoc2 The DCO check is now passing ✅ (the second commit already had the correct with email). Since there was a force push after your approval, could you re-approve when you get a chance? Thank you! |
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
2 participants
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.
Description
Several subcommands were missing help text for arguments and options, resulting in blank descriptions in
--helpoutput. Fixes #3454.Add
///doc comments to the fields listed in the issue:kill:<CONTAINER_ID>,<SIGNAL>,--allrun:--keepexec:--ttypause,resume,start,state,delete,ps,update:<CONTAINER_ID>Type of Change