Merge a7baba0 into 693df28

.github/workflows/pypi.yml

@@ -2,10 +2,10 @@ name: PyPI
 on:
   push:
     branches:
-      - master
+      - main
       - auto-release
   pull_request:
-    branches: [master]
+    branches: [main]
   release:
     types: [published]
 

.github/workflows/tests.yml

@@ -3,10 +3,10 @@ name: Tests
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
     branches:
-      - master
+      - main
 
 jobs:
   changes:

README.md

@@ -25,21 +25,28 @@ make check
 
 ## Examples
 
-`unification` has built-in support for most Python data types:
+`unification` has built-in support for unifying most Python data types via the function `unify`:
 
 ```python
 >>> from unification import *
 >>> unify(1, 1)
 {}
 >>> unify(1, 2)
 False
->>> x = var('x')
+>>> x = var()
 >>> unify((1, x), (1, 2))
 {~x: 2}
 >>> unify((x, x), (1, 2))
 False
 ```
 
+Unifiable objects containing logic variables can also be reified using `reify`:
+
+```python
+>>> reify((1, x), {x: 2})
+(1, 2)
+```
+
 And most Python data structures:
 
 ``` python
@@ -48,7 +55,7 @@ And most Python data structures:
 >>> unify({"a": 1, "b": 2}, {"a": x, "b": 2, "c": 3})
 False
 >>> from collections import namedtuples
->>> ntuple = namedtuple("ntuple", ("a", "b")) 
+>>> ntuple = namedtuple("ntuple", ("a", "b"))
 >>> unify(ntuple(1, 2), ntuple(x, 2))
 {~x: 1}
 ```

unification/core.py

@@ -25,11 +25,11 @@ def assoc(s, u, v):
 
 
 def stream_eval(z, res_filter=None):
-    """Evaluate a stream of `_reify`/`_unify` results.
+    r"""Evaluate a stream of `_reify`/`_unify` results.
 
     This implementation consists of a deque that simulates an evaluation stack
     of `_reify`/`_unify`-produced generators.  We're able to overcome
-    `RecursionError`s this way.
+    `RecursionError`\s this way.
     """
 
     if not isinstance(z, Generator):
@@ -79,7 +79,7 @@ def _reify_Var(o, s):
 
 
 def _reify_Iterable_ctor(ctor, t, s):
-    """Create a generator that yields _reify generators.
+    """Create a generator that yields `_reify` generators.
 
     The yielded generators need to be evaluated by the caller and the fully
     reified results "sent" back to this generator so that it can finish
@@ -237,7 +237,7 @@ def _unify_slice(u, v, s):
 
 @dispatch(object, object, Mapping)
 def unify(u, v, s):
-    """Find substitution so that u == v while satisfying s.
+    """Find substitution so that ``u == v`` while satisfying `s`.
 
     >>> x = var('x')
     >>> unify((1, x), (1, 2), {})