docs: add Long description and example to version command - #1350
docs: add Long description and example to version command#1350ogulcanaydogan wants to merge 1 commit into
Conversation
Signed-off-by: Ogulcan Aydogan <ogulcanaydogan@hotmail.com>
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.
| 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 PR is stale because it has been opened for 45 days with no activity. Remove stale label or comment. Otherwise, it will be closed in 30 days. |
|
Bumping this, still a small doc-only change and CI is green. Happy to adjust if the format doesn't match what you'd prefer. |
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.