From c673db7a4ec250fd41a8f19a7dd0b0dbf0608dd2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?=
 <martin.horenovsky@gmail.com>
Date: Thu, 26 Nov 2020 09:43:52 +0100
Subject: [PATCH] Add explanatory comment to CumulativeReporterBase

---
 src/catch2/reporters/catch_reporter_cumulative_base.hpp | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/catch2/reporters/catch_reporter_cumulative_base.hpp b/src/catch2/reporters/catch_reporter_cumulative_base.hpp
index 26c62ef5..94b4c589 100644
--- a/src/catch2/reporters/catch_reporter_cumulative_base.hpp
+++ b/src/catch2/reporters/catch_reporter_cumulative_base.hpp
@@ -64,12 +64,15 @@ namespace Catch {
         void testCaseEnded( TestCaseStats const& testCaseStats ) override;
         void testGroupEnded( TestGroupStats const& testGroupStats ) override;
         void testRunEnded( TestRunStats const& testRunStats ) override;
+        //! Customization point: called after last test finishes (testRunEnded has been handled)
         virtual void testRunEndedCumulative() = 0;
 
         void skipTest(TestCaseInfo const&) override {}
 
         IConfig const* m_config;
         std::ostream& stream;
+        // Note: We rely on pointer identity being stable, which is why
+        //       which is why we store around pointers rather than values.
         std::vector<std::shared_ptr<TestCaseNode>> m_testCases;
         std::vector<std::shared_ptr<TestGroupNode>> m_testGroups;