docs

perftester: documentation

This folder contains a number of files that serve two functions: documentation and testing. The main README contains basic information about how to use perftester, while this folder collects both basic and more advanced knowledge of using the package. All these files serve also as doctests (doctest being the only testing framework used in perftester).

The knowledge is collected in the following files:

• Basic use of time_test()
• Basic use of memory_usage_test()
• Using perftester.config for advanced performance testing
• Using perftester for simple benchmarking, and for performance testing a function relative to the performance of another function
• Use case of raw time testing
• Changing a built-in benchmarking function
• Use of the perftester.pp() function
• Use of perftester as a command-line testing framework

You can also read the test files, located in the tests folder.