docs: document embedded Clara and drop archived upstream link (#2312) - #3191
Open
annacastroops wants to merge 3 commits into
Open
docs: document embedded Clara and drop archived upstream link (#2312)#3191annacastroops wants to merge 3 commits into
annacastroops wants to merge 3 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## devel #3191 +/- ##
=======================================
Coverage 91.27% 91.27%
=======================================
Files 204 204
Lines 8973 8973
=======================================
Hits 8190 8190
Misses 783 783 🚀 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.
Summary
Adds Catch2-owned Clara documentation and stops pointing users at the archived standalone Clara repository (#2312).
Clara has lived only inside Catch2 for years (
src/catch2/internal/catch_clara.hpp). The old upstream README is inactive and no longer matches the embedded parser.Changes
docs/clara.mdcoveringOpt/Arg/Helpcomposition used withsession.cli()docs/own-main.md: link to the new pagedocs/Readme.md: index entry under Fine tuningCloses #2312