docs: add Long description and example to version command#1350
Open
ogulcanaydogan wants to merge 1 commit into
Open
docs: add Long description and example to version command#1350ogulcanaydogan wants to merge 1 commit into
ogulcanaydogan wants to merge 1 commit into
Conversation
Signed-off-by: Ogulcan Aydogan <ogulcanaydogan@hotmail.com>
ogulcanaydogan
requested review from
NiazFK,
gokarnm,
priteshbandi,
rgnote,
shizhMSFT,
toddysm,
vaninrao10 and
yizha1
as code owners
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR enhances the notation version CLI help output by adding a long description with an example invocation, improving discoverability for users.
Changes:
- Add
Longhelp text for theversioncommand - Include an explicit example usage block in the help text
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+28
to
+32
| Long: `Show the notation version information | ||
|
|
||
| Example - Show notation version: | ||
| notation version | ||
| `, |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1350 +/- ##
==========================================
+ Coverage 79.09% 79.12% +0.02%
==========================================
Files 68 68
Lines 3076 3080 +4
==========================================
+ Hits 2433 2437 +4
Misses 436 436
Partials 207 207 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
The
versioncommand had aShort:description but noLong:or example, unlike most other commands. Add aLong:with a usage example to match the pattern used by other notation commands.