README-en.md edited on August 3, 2016 at 10:55am

README-en.md

 
 [Verano 2016 - Ive - Coralys]
 
-As you have learned in previous labs, getting a program to compile is only a minor part of programming. The compiler will tell you if there are any syntactical errors, but it isn't capable of detecting logical problems in your program. It's very important to test the program's functions to validate that they produce correct results.
+As you have learned in previous laboratory experiences, getting a program to compile is only a minor part of programming. The compiler will tell you if there are any syntactical errors, but it isn't capable of detecting logical problems in your program. It's very important to test the program's functions to validate that they produce correct results.
 
-These tests can be performed by hand, this is, running the program multiple times, providing representative inputs and visually checking that the program outputs correct results. A more convenient way is to implement functions in the program whose sole purpose is to validate that other functions are working correctly. In this lab you will be practicing both testing methods.
+These tests can be performed by hand; this is, running the program multiple times, providing representative inputs and visually checking that the program outputs correct results. A more convenient way is to implement functions in the program whose sole purpose is to validate that other functions are working correctly. In this laboratory experience, you will be practicing both testing methods.
 
 
 ## Objectives:
 
 ---
 
-## Testing a function
+## Testing a Function
 
 When we test a function's validity we should test cases that activate the various results the function could return.
 
 
 ---
 
-### The`assert` function:
+### The`assert` Function
 
-The `assert(bool expression)` function can be used as a rudimentary tool to validate functions. `assert` has a very powerful, yet simple functionality. If the expression that we place between the `assert` parenthesis is *true*, the function allows the program to continue onto the next instruction. Otherwise, if the expression we place between the parenthesis is *false*, the `assert` function causes the program to terminate and prints an error message on the terminal, that informs the user about the `assert` instruction that failed.
+The `assert(bool expression)` function can be used as a rudimentary tool to validate functions. `assert` has a very powerful, yet simple functionality. If the expression that we place between the `assert` parenthesis is *true*, the function allows the program to continue onto the next instruction. Otherwise, if the expression we place between the parenthesis is *false*, the `assert` function causes the program to terminate and print out an error message on the terminal, that informs the user about the `assert` instruction that failed.
 
 For example, the following program will run from start to finish without problems since every expression included in the assert's parentheses evaluates to *true*.
 
 The program will not execute the remaining instructions after line 8.
 
 
-#### How to use assert to validate functions?
+#### How to Use Assert to Validate Functions?
 
 Suppose that you want to automate the validation of the `ageRange`. One way to do it is by implementing and calling a function that calls the `ageRange` function with different arguments and verifies that each returned value is equal to the expected result. If the `ageRange` function returns a value that is not expected, the testing function aborts the program and reports the test that failed. The following illustrates a function to test the `ageRange` function. Observe that it consists of one assert per each of the tests we had listed earlier. 
 
 
 ## Laboratory Session:
 
-### Exercise 1: Designing tests by hand
+### Exercise 1 - Designing Tests by Hand
 
 In this exercise you will practice how to design tests to validate functions, using only the function's description and the graphical user interface that is used to interact with the function.
 
 
 ![figure4.png](images/figure4.png)
 
-**Figure 4** - Interface for a program that finds the max value out of three integers.
+**Figure 4.** Interface for a program that finds the max value out of three integers.
 
 ---
 
 If one of these three cases does not have the expected result, your friend's program does not work. On the other hand, if the three cases work, then the program has a high probability of being correct.
 
 
-#### Functions to validate
+#### Functions to Validate
 
 In this exercise you will be designing tests to validate various versions of the functions that are described below. Each one of the functions has four versions, "Alpha", "Beta", "Gamma" and "Delta".
 
 
     ![figure5.png](images/figure5.png)
 
-    **Figure 5** - Interface for the `3 Sorts` function.
+    **Figure 5.** Interface for the `3 Sorts` function.
 
     ---
 
 
     ![figure6.png](images/figure6.png)
 
-    **Figure 6** - Interface for the `Dice` function.
+    **Figure 6.** Interface for the `Dice` function.
 
     ---
 
 
     ![figure7.jpg](images/figure7.jpg)
 
-    **Figure 7** - Ways to win in "Rock, paper, scissors".
+    **Figure 7.** Ways to win in the "Rock, paper, scissors" game.
 
     ---
 
     ![figure8.png](images/figure8.png)
 
-    **Figure 8** - Interface for the `Rock, Paper, Scissors` function.
+    **Figure 8.** Interface for the `Rock, Paper, Scissors` function.
 
     ---
 
 
     ![figure9.png](images/figure9.png)
 
-    **Figure 9** - Interface for the `Zulu time` function.
+    **Figure 9.** Interface for the `Zulu time` function.
 
     ---
 
   | 2       | "deer", "fox", "coyote" | "fox", "deer", "coyote" | ....      | ....       |            |
   | ....    | ....                      | ....                      | ....      | ....       | ....       |
   
-  **Figure 10** - Table to organize the test results.
+  **Figure 10.** Table to organize the test results.
 
   ---
 
 You can see examples of how to organize your results [here](images/example01.png) and [here](images/example02.png).
 
 
-### Exercise 2: Doing tests “by hand”
+### Exercise 2 - Doing Tests “by Hand”
 
 The `testing` project implements several versions of each of the four functions that were described in Exercise 1. Some or all of the implementations could be incorrect. Your task is, using the tests you designed in Exercise 1, to test the versions for each function to determine which of them, if any, are implemented correctly.
 
 
     ![figure11.png](images/figure11.png)
 
-    **Figure 11** - Window to select the function that will be tested.
+    **Figure 11.** Window to select the function that will be tested.
 
     ---
 
 
 
 
-### Exercise 3: Using `assert` to make unit tests
+### Exercise 3 - Using `assert` to Make Unit Tests
 
 Doing tests by hand each time you run a program is a tiresome task. In the previous exercises you did it for a few simple functions. Imagine doing the same for a complex program like a search engine or a word processor!
 
 *Unit tests* help programmers validate code and simplify the process of debugging while avoiding having to do these tests by hand in each execution.
 
-#### Instructions:
+#### Instructions
 
 1. In the `QtCreator` menu, go to `Build` and select `Clean Project "Testing"`. Then go to `File` and select `Close Project "Testing"`.
 
 
      This is evidence enough to establish that the `fact` function is NOT correctly implemented.
 
-4. Notice that, by failing the previous test, the program did not continue its execution. To test the code you will write, comment the `test_fact()` call in `main`.
+4. Notice that, by failing the previous test, the program did not continue its execution. To test the code you will write, comment the `test_fact()` called in `main`.
 
 5. Write a unit test called `test_isALetter` for the `isALetter` function. Write various asserts in the unit test to try some data and its expected values (use the `test_fact` function for inspiration). Invoke `test_isALetter` from `main` and execute your program. If the `isALetter` function passes the test you wrote, continue writing asserts and executing the program until one of them fails.
 
 
 1. Use "Deliverable 1" in Moodle to turn in the table with the tests you designed in Exercise 1 and that you completed in Exercise 2, with the results from the function tests.
 
-2. Use "Deliverable 2" in Moodle to turn in the `main.cpp` file that contains the `test_isALetter`, `test_isValidTime`, `test_gcd` functions and their calls. Remember to use good programming techniques by including the name of the programmers involved and documenting your program.
+2. Use "Deliverable 2" in Moodle to turn in the `main.cpp` file that contains the `test_isALetter`, `test_isValidTime`, `test_gcd` functions and their calls. Remember to use good programming techniques, include the name of the programmers involved, and document your program.
 
 ---