Update docs

avanov · May 1, 2019 · 35ea383 · 35ea383
1 parent 39f444f
commit 35ea383
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 7 deletions.
diff --git a/README.rst b/README.rst
@@ -19,7 +19,7 @@
     :alt: Latest PyPI Release
 
 
-**Development status: Alpha**
+**Development status: Beta**
 
 Typeit
 ------

diff --git a/docs/quickstart_guide.rst b/docs/quickstart_guide.rst
@@ -4,11 +4,11 @@ Quickstart Guide
 
 .. CAUTION::
 
-    The project is in an early development status, and a few public
+    The project is in a beta development status, and a few public
     APIs may change in a backward-incompatible manner.
 
 
-``typeit`` supports Python 3.7+.
+``typeit`` supports Python 3.6+.
 
 
 Installation
@@ -73,12 +73,20 @@ and rename the whole structure to better indicate the nature of the data:
     }
 
 
-    mk_person, dict_person = type_constructor(Person, overrides)
+    mk_person, dict_person = type_constructor & overrides ^ Person
 
 
 ``typeit`` will handle creation of the constructor ``mk_person :: Dict -> Person`` and the serializer
 ``dict_person :: Person -> Dict`` for you.
 
+``type_constructor & overrides`` produces a new type constructor that takes overrides into consideration,
+and ``type_constructor ^ Person`` reads as "type constructor applied to the Person structure" and essentially
+is the same as ``type_constructor(Person)``, but doesn't require parentheses around overrides (and extensions):
+
+.. code-block:: python
+
+    (type_constructor & overrides & extension & ...)(Person)
+
 
 Overrides
 ---------
@@ -99,7 +107,7 @@ our ``Person`` type:
     }
 
 
-    mk_person, dict_person = type_constructor(Person, overrides)
+    mk_person, dict_person = type_constructor & overrides ^ Person
 
 
 This is the way we can indicate that our Python structure has different field
@@ -137,5 +145,15 @@ any nested types, for instance:
     }
 
 
-    mk_person, dict_person = type_constructor(Person, overrides)
+    mk_person, dict_person = type_constructor & overrides ^ Person
+
+
+Extensions
+----------
+
+TODO
+
+Handling errors
+---------------
 
+TODO
diff --git a/setup.py b/setup.py
@@ -42,7 +42,7 @@ def requirements(at_path: Path):
       description='typeit brings typed data into your project',
       long_description=README,
       classifiers=[
-          'Development Status :: 3 - Alpha',
+          'Development Status :: 4 - Beta',
           'Intended Audience :: Developers',
           'License :: OSI Approved',
           'License :: OSI Approved :: MIT License',