Add note about custom prio possibly breaking later

In the case that Sphinx/intersphinx *were* to impose some constraints on the field.
bskinn · Nov 13, 2020 · 6ed949f · 6ed949f
1 parent 78dea4b
commit 6ed949f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/doc/source/syntax.rst b/doc/source/syntax.rst
@@ -113,6 +113,8 @@ be exactly:
     it is only used internally within the search function of the static webpages
     built *by Sphinx* (|prio_py_search|_ and |prio_js_search|_). Thus, custom
     inventories likely **MAY** use this field for arbitrary content, if desired.
+    This *would* run the risk of a future change to Sphinx/intersphinx causing
+    such custom |objects.inv| files to become incompatible.
 
     **Constraints**