Merge 22c53b9 into 697345b

inspirehep · Oct 14, 2016 · 7395748 · 7395748
2 parents 697345b + 22c53b9
commit 7395748
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -30,6 +30,16 @@ User's Guide
 This part of the documentation will show you how to get started in using
 inspire-schemas.
 
+**NOTE**: is highly encouraged to pin the version of inspire-schemas that you
+use to the major number, for example using the `~=` version matcher in your
+`requires.txt` or your `setup.py` like::
+
+    inspire-schemas~=1.1.0
+
+That will prevent any major update (compatibility breaking) to be pulled
+automatically, and will only download minor and feature updates (1.X.Y).
+
+
 .. toctree::
    :maxdepth: 2