GithubHelp home page GithubHelp logo

Update documentation for v3 about catch2 HOT 2 OPEN

horenmar avatar horenmar commented on June 5, 2024
Update documentation for v3

from catch2.

Comments (2)

horenmar avatar horenmar commented on June 5, 2024

Note on mdsnippets: they do not promise that hashes used in links are stable, thus potentially causing pointless churn in diffs. Using them also imposes extra work on contributors, requiring them to install a dotnet tool.

One way to avoid this issue is to only regenerate snippets as part of release procedure, alongside other automatic documentation updates, such as rewriting the version placeholders. When limited to once per release, the potential churn in diffs is reasonable, and it avoids imposing the requirement onto all contributors.

The downside of this approach is that breakage in documentation can be discovered much later than it happens.

from catch2.

lucid-ben-sizer avatar lucid-ben-sizer commented on June 5, 2024

I would love this to include information about how to structure a project to make proper use of this framework. It builds perfectly using add_subdirectory and if I paste the factorial example into my code, that too builds fine. But I have no idea how to make or run a test suite. I can't find anything in the docs about the recommended directory layout or how a project would normally be configured to use catch2.

from catch2.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.