diff --git a/README.rst b/README.rst index 5af3818..bd99793 100644 --- a/README.rst +++ b/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): ... diff --git a/docs/python.rst b/docs/python.rst index b8ecdd5..7bb05ae 100644 --- a/docs/python.rst +++ b/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): ...