Skip to content

Commit c9e05fc

Browse files
committed
Update UsersGuide.md
Add links to examples. Add info about optData functionality to the documentation.
1 parent b6b3dba commit c9e05fc

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

Docs/UsersGuide.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,8 @@ In this way, any object that inherits from FTObject can be stored in a
158158
container, including other containers, making these containers quite
159159
generic.
160160

161+
Other examples can be found in the [Examples](../Examples) directory, which has examples for using a linked list, and for a simple RPN calculator. Finally, the test routines in the [Testing](../Testing) directory provide examples of all of the features of the library.
162+
161163
# Memory Management
162164

163165
FTObjectLibrary uses a manual retain-release memory management model
@@ -1221,16 +1223,17 @@ An example of running a suite of tests is the following:
12211223

12221224
CALL testSuite % performTests()
12231225

1224-
The test subroutines have no arguments. The interface is
1226+
The test subroutines have no arguments or include optional data. The interface is
12251227

12261228
ABSTRACT INTERFACE
1227-
SUBROUTINE testSuiteFunction()
1228-
END SUBROUTINE testSuiteFunction
1229+
SUBROUTINE testSuiteFunction(optData)
1230+
CHARACTER(LEN=1), POINTER, OPTIONAL :: optData(:)
1231+
END SUBROUTINE testSuiteFunction
12291232
END INTERFACE
12301233

12311234
The test functions should USE the FTAssertions module as in the previous
12321235
section. You don't have to do any reporting code in your tests, however.
1233-
Reporting is managed by the testSuiteManager at the end of performTests. Look at the Testing directory in the repository for examples on how to set up testing.
1236+
Reporting is managed by the testSuiteManager at the end of performTests. Look at the [Testing](../Testing) directory in the repository for examples on how to set up testing.
12341237

12351238
**Definition:**
12361239

0 commit comments

Comments
 (0)