#3206
Pull Requests/catchorg/Catch2/#3206

docs: add documentation for internal Clara CLI parser

OpenReturnKartikeywants to merge intofrom
1 commit3 files changed+337-1

This PR adds dedicated documentation for the internal Clara command line parser, as requested in #2312.

Catch2 embeds Clara as its CLI parser, allowing users to compose their own options on top of Catch2's defaults when writing a custom main(). However, docs/own-main.md previously linked to the external catchorg/Clara repository, which was archived several years ago.

Changes in this PR:

  • Adds docs/clara.md documenting Clara's types, options, positional arguments, lambda validation, and integration with Catch::Session.
  • Updates docs/own-main.md to link to clara.md.
  • Adds an entry for Clara in docs/Readme.md under Fine tuning.

Closes #2312

Activity

2
R
docs: add documentation for internal Clara CLI parser
54ad300
codecov[bot]1mo ago

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 91.17%. Comparing base (02f8b55) to head (54ad300).

Additional details and impacted files 
@@           Coverage Diff           @@
##            devel    #3206   +/-   ##
=======================================
  Coverage   91.17%   91.17%           
=======================================
  Files         206      206           
  Lines        9080     9080           
=======================================
  Hits         8278     8278           
  Misses        802      802
:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.