Promote TEST_ORDERED to first-class interface#48
Merged
Conversation
Include Ordered.hpp from test.hpp so TEST_ORDERED and TEST_ORDERED_C_WRAPPER are available without a separate include. Merge ordered-tests.rst into test-macros.rst (adding TEST_ORDERED_C_WRAPPER to the C wrapper table and OrderedTest.test.cpp to examples), and remove the now-redundant standalone page from the toctree.
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.
Description
TEST_ORDEREDandTEST_ORDERED_C_WRAPPERare test-definition macros on par withTEST,IGNORE_TEST, andEXPECT_FAIL_TEST, but they required a separate#include "mutiny/test/Ordered.hpp"rather than being available through the aggregatetest.hpp. This change corrects that inconsistency.#include "mutiny/test/Ordered.hpp"toinclude/mutiny/test.hppso the ordered-test macros are available to any file that includestest.hpp.docs/ordered-tests.rstintodocs/test-macros.rstas a new "Ordered Tests" section. The page-level note ("Includemutiny/test.hppfor all macros on this page") now accurately covers ordered macros too.TEST_ORDERED_C_WRAPPERto the C Wrapper Macros table andOrderedTest.test.cppto the Examples table intest-macros.rst.ordered-tests.rstpage and itstoctreeentry.Related Issues
Fixes # (issue number)
Type of Change
Manual Verification (Optional)
N/A
Checklist
docs/for any user-facing changes.mu::tinynamespace,INCLUDED_MUTINY_guards,mutiny_C-prefix)..hand.c.cpp) is required for parity.CONTRIBUTING.mdfile to ensure compliance with architectural guidelines.