Skip to content

Commit e09bf69

Browse files
BryanChan777cclauss
authored andcommitted
Update README.md (TheAlgorithms#1588)
* Update README.md * python -m unittest -v
1 parent c5fd075 commit e09bf69

File tree

1 file changed

+7
-11
lines changed

1 file changed

+7
-11
lines changed

linear_algebra/README.md

+7-11
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Linear algebra library for Python
22

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.
44

55
---
66

77
## Overview
88

99
### class Vector
1010
-
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.
1212

1313
**Overview about the methods:**
1414
@@ -58,22 +58,18 @@ This module contains some useful classes and functions for dealing with linear a
5858

5959
## Documentation
6060

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)`.
6663

6764
---
6865

6966
## Usage
7067

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`.
7370

7471
---
7572

7673
## Tests
7774

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

Comments
 (0)