Add warning

adamboche · Feb 2, 2020 · 53d2ce9 · 53d2ce9
1 parent deb0fde
commit 53d2ce9
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 31 deletions.
diff --git a/README.rst b/README.rst
@@ -60,40 +60,9 @@ Union fields for marshmallow.
 
 * Free software: MIT license
 
-Installation
-============
-
-::
-
-    pip install marshmallow-union
 
 Documentation
 =============
 
 
 https://python-marshmallow-union.readthedocs.io/
-
-
-Development
-===========
-
-To run the all tests run::
-
-    tox
-
-Note, to combine the coverage data from all the tox environments run:
-
-.. list-table::
-    :widths: 10 90
-    :stub-columns: 1
-
-    - - Windows
-      - ::
-
-            set PYTEST_ADDOPTS=--cov-append
-            tox
-
-    - - Other
-      - ::
-
-            PYTEST_ADDOPTS=--cov-append tox
diff --git a/docs/conf.py b/docs/conf.py
@@ -53,3 +53,13 @@
 napoleon_use_param = True
 
 autoapi_dirs = ["../src/marshmallow_union"]
+
+
+rst_prolog = """
+.. warning::
+
+   Figuring out the correct field type from an untagged dump is a matter of guesswork and
+   can be error-prone. A more explicit approach like
+   https://github.com/Bachmann1234/marshmallow-polyfield/ is better. This project remains
+   here to avoid breaking existing software.
+"""
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -2,6 +2,7 @@
 Usage
 =====
 
+
 To use marshmallow-union in a project import ``marshmallow_union.Union`` and pass it a
 list of ``marshmallow.fields.Field`` instances.