Add docstrings to pybind bindings and add doctest examples to docstri…

…ngs. Fixes #13
oscarhiggott · Sep 5, 2021 · e4fa28b · e4fa28b
1 parent 96c0a75
commit e4fa28b
Show file tree

Hide file tree

Showing 6 changed files with 715 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ pip install -e ./PyMatching
 ```
 The installation may take a few minutes since the C++ extension has to be compiled. If you'd also like to run the tests, first install [pytest](https://docs.pytest.org/en/stable/), and then run:
 ```
-pytest ./PyMatching/tests
+pytest ./PyMatching/tests ./PyMatching/src
 ```
 
 ## Usage

diff --git a/src/pymatching/__init__.py b/src/pymatching/__init__.py
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from pymatching._cpp_mwpm import (randomize, set_seed, rand_float)
+from pymatching._cpp_mwpm import (randomize, set_seed, rand_float, BlossomFailureException)
 from pymatching.matching import *
 
 randomize() # Set random seed using std::random_device