From 8b86b95aee355d777d5659fcb6883819bce2a782 Mon Sep 17 00:00:00 2001 From: p1c2u Date: Tue, 24 Feb 2026 01:38:29 +0000 Subject: [PATCH] Clarify usage example for intentionally invalid spec --- README.rst | 5 ++++- docs/python.rst | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) 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): ...