docs: comment --target follow-up
#430
Merged
Conversation
This file contains 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
casperdcl
added
documentation
casperdcl
changed the title
comment --target follow-up
casperdcl
force-pushed
the
comment-target
branch
from
f5e950f to
ad86a9a
Compare
casperdcl
commented
Jan 4, 2023
content/docs/ref/comment.md
Outdated
Comment on lines
32
to
35
| - `--target=<pr|commit|issue</ref>>`: Where to post/associate with the comment | ||
| (`pr`, `commit`, `issue`), optionally with a reference (`issue/12`, `pr/17`, | ||
| `commit/`[rev](https://git-scm.com/docs/gitrevisions) [default: `pr` falling | ||
| back to `commit/HEAD`]. |
There was a problem hiding this comment.
might be worth updating CLI --help to match this.
| @@ -6,7 +6,7 @@ cml pr create [options] <pathspec>... | |||
|
|
|||
| Commit specified files to a new branch and create a pull request. If sending a | |||
| report afterwards, consider using | |||
| [`cml comment update --target=pr`](/doc/ref/comment#update). | |||
| [`cml comment update`](/doc/ref/comment#update). | |||
There was a problem hiding this comment.
just double-checking: the --target=pr flag is auto-inferred here, right?
There was a problem hiding this comment.
Yes, by default the target is automatically decided based on dark magic of all sorts; see iterative/cml#1228.
There was a problem hiding this comment.
Although it's not clear to me whether the documentation is suggesting users to comment on the ancillary pull request or the main one. 🤔
Link Check ReportThere were no links to check! |
0x2b3bfa0
reviewed
Jan 4, 2023
Co-authored-by: Helio Machado <[email protected]>
tasdomas
approved these changes
Jan 13, 2023
Link Check ReportThere were no links to check! |
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.
actions/checkout.with.ref: ${{ github.event.pull_request.head.sha }}--target=prflagFollow-up to #415