docs: Replace Clara external link with internal documentation #3062
+169
−1
Conversation
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
Replace the link to the archived catchorg/Clara repository in own-main.md with a link to a new internal documentation page. Clara has been developed as part of Catch2 for several years now, and the external repository is no longer maintained. The new clara.md documents the Clara API including: - Opt for options and flags - Arg for positional arguments - Parser composition with the | operator - Lambda handlers with validation - Integration with Catch2's Session Fixes catchorg#2312
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## devel #3062 +/- ##
==========================================
+ Coverage 91.14% 91.18% +0.03%
==========================================
Files 202 202
Lines 8831 8831
==========================================
+ Hits 8049 8052 +3
+ Misses 782 779 -3 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Replace the link to the archived catchorg/Clara repository in own-main.md with a link to a new internal documentation page.
Changes
NEW docs/clara.md - Documents the Clara CLI parser API including:
MODIFIED docs/own-main.md - Updated link from archived external repo to internal docs
Background
Clara has been developed as part of Catch2 for several years now (as noted in the issue), and the external repository at catchorg/Clara is no longer maintained and has been archived.
Fixes #2312