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

fix: add --name for capture create command examples #412

Merged
merged 1 commit into from
May 29, 2024

Conversation

mainred
Copy link
Contributor

@mainred mainred commented May 29, 2024

Description

Since --name is required to create a capture through CLI, we need to update the capture create command examples in docs.

Related Issue

fix #410

Checklist

  • I have read the contributing documentation.
  • I signed and signed-off the commits (git commit -S -s ...). See this documentation on signing commits.
  • I have correctly attributed the author(s) of the code.
  • I have tested the changes locally.
  • I have followed the project's style guidelines.
  • I have updated the documentation, if necessary.
  • I have added tests, if applicable.

Screenshots (if applicable) or Testing Completed

Not required

Additional Notes

Add any additional notes or context about the pull request here.


Please refer to the CONTRIBUTING.md file for more information on how to contribute to this project.

@mainred mainred requested a review from a team as a code owner May 29, 2024 17:05
@mainred mainred requested review from matmerr and vakalapa May 29, 2024 17:05
@rbtr rbtr added the area/documentation Improvements or additions to documentation label May 29, 2024
Copy link
Collaborator

@rbtr rbtr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks ❤️

@rbtr rbtr added this pull request to the merge queue May 29, 2024
Merged via the queue into microsoft:main with commit 1b89e04 May 29, 2024
21 checks passed
matmerr pushed a commit to matmerr/retina that referenced this pull request Jul 3, 2024
# Description

Since `--name` is required to create a capture through CLI, we need to
update the capture create command examples in docs.

## Related Issue

fix microsoft#410

## Checklist

- [x] I have read the [contributing
documentation](https://retina.sh/docs/contributing).
- [x] I signed and signed-off the commits (`git commit -S -s ...`). See
[this
documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification)
on signing commits.
- [x] I have correctly attributed the author(s) of the code.
- [x] I have tested the changes locally.
- [ ] I have followed the project's style guidelines.
- [ ] I have updated the documentation, if necessary.
- [ ] I have added tests, if applicable.

## Screenshots (if applicable) or Testing Completed

Not required

## Additional Notes

Add any additional notes or context about the pull request here.

---

Please refer to the [CONTRIBUTING.md](../CONTRIBUTING.md) file for more
information on how to contribute to this project.

Signed-off-by: Qingchuan Hao <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Update capture docs with required flag --name
2 participants