From b4aca70fd9e0ddf0afbdafb1b826f5edcfc1049b Mon Sep 17 00:00:00 2001 From: Mark VanderVoord Date: Wed, 6 Dec 2017 10:08:56 -0500 Subject: [PATCH] Update UnityGettingStartedGuide.md Added more detail on test naming. --- docs/UnityGettingStartedGuide.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/UnityGettingStartedGuide.md b/docs/UnityGettingStartedGuide.md index 50fc91c..81d0398 100644 --- a/docs/UnityGettingStartedGuide.md +++ b/docs/UnityGettingStartedGuide.md @@ -100,10 +100,11 @@ find setUp or tearDown when it links, you'll know you need to at least include an empty function for these. The majority of the file will be a series of test functions. Test functions -follow the convention of starting with the word "test" or "spec". You don't HAVE +follow the convention of starting with the word "test_" or "spec_". You don't HAVE to name them this way, but it makes it clear what functions are tests for other -developers. Test functions take no arguments and return nothing. All test -accounting is handled internally in Unity. +developers. Also, the automated scripts that come with Unity or Ceedling will default +to looking for test functions to be prefixed this way. Test functions take no arguments +and return nothing. All test accounting is handled internally in Unity. Finally, at the bottom of your test file, you will write a `main()` function. This function will call `UNITY_BEGIN()`, then `RUN_TEST` for each test, and -- GitLab