|
1 | 1 | # Linear algebra library for Python
|
2 | 2 |
|
3 |
| -This module contains some useful classes and functions for dealing with linear algebra in python 2. |
| 3 | +This module contains classes and functions for doing linear algebra. |
4 | 4 |
|
5 | 5 | ---
|
6 | 6 |
|
7 | 7 | ## Overview
|
8 | 8 |
|
9 | 9 | ### class Vector
|
10 | 10 | -
|
11 |
| - - This class represents a vector of arbitray size and operations on it. |
| 11 | + - This class represents a vector of arbitray size and related operations. |
12 | 12 |
|
13 | 13 | **Overview about the methods:**
|
14 | 14 |
|
@@ -58,22 +58,18 @@ This module contains some useful classes and functions for dealing with linear a
|
58 | 58 |
|
59 | 59 | ## Documentation
|
60 | 60 |
|
61 |
| -The module is well documented. You can use the python in-built ```help(...)``` function. |
62 |
| -For instance: ```help(Vector)``` gives you all information about the Vector-class. |
63 |
| -Or ```help(unitBasisVector)``` gives you all information you needed about the |
64 |
| -global function ```unitBasisVector(...)```. If you need informations about a certain |
65 |
| -method you type ```help(CLASSNAME.METHODNAME)```. |
| 61 | +This module uses docstrings to enable the use of Python's in-built `help(...)` function. |
| 62 | +For instance, try `help(Vector)`, `help(unitBasisVector)`, and `help(CLASSNAME.METHODNAME)`. |
66 | 63 |
|
67 | 64 | ---
|
68 | 65 |
|
69 | 66 | ## Usage
|
70 | 67 |
|
71 |
| -You will find the module in the **src** directory its called ```lib.py```. You need to |
72 |
| -import this module in your project. Alternative you can also use the file ```lib.pyc``` in python-bytecode. |
| 68 | +Import the module `lib.py` from the **src** directory into your project. |
| 69 | +Alternatively, you can directly use the Python bytecode file `lib.pyc`. |
73 | 70 |
|
74 | 71 | ---
|
75 | 72 |
|
76 | 73 | ## Tests
|
77 | 74 |
|
78 |
| -In the **src** directory you also find the test-suite, its called ```tests.py```. |
79 |
| -The test-suite uses the built-in python-test-framework **unittest**. |
| 75 | +`src/tests.py` contains Python unit tests which can be run with `python3 -m unittest -v`. |
0 commit comments