Merge pull request #468 from python-openapi/docs/clarify-intentionally-invalid-validate-example

Clarify usage example for intentionally invalid spec

Author: p1c2u

README.rst

@@ -104,7 +104,10 @@ Python package
     # If no exception is raised by validate(), the spec is valid.
     validate(spec_dict)
 
-    validate({'openapi': '3.1.0'})
+    # Example of an intentionally invalid spec.
+    invalid_spec = {'openapi': '3.1.0'}
+
+    validate(invalid_spec)
 
     Traceback (most recent call last):
         ...

docs/python.rst

@@ -13,7 +13,10 @@ By default, OpenAPI spec version is detected. To validate spec:
     # If no exception is raised by validate(), the spec is valid.
     validate(spec_dict)
 
-    validate({'openapi': '3.1.0'})
+    # Example of an intentionally invalid spec.
+    invalid_spec = {'openapi': '3.1.0'}
+
+    validate(invalid_spec)
 
     Traceback (most recent call last):
     ...