Skip to content

Commit

Permalink
Duplicate warning
Browse files Browse the repository at this point in the history
  • Loading branch information
adamboche committed Feb 2, 2020
1 parent eacccb8 commit b986e80
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 8 deletions.
8 changes: 7 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,14 @@ Union fields for marshmallow.

* Free software: MIT license

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

.. include:: warning.rst

Documentation
=============
Expand Down
11 changes: 10 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,13 @@
autoapi_dirs = ["../src/marshmallow_union"]


rst_prolog = pathlib.Path(__file__).parent.parent.joinpath("warning.rst").read_text()
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.
"""
6 changes: 0 additions & 6 deletions warning.rst

This file was deleted.

0 comments on commit b986e80

Please sign in to comment.