Add docstring to explain purpose of test class

ONSdigital · Jan 25, 2024 · f912499 · f912499
1 parent 77c3c95
commit f912499
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/tests/integration/test_create_token.py b/tests/integration/test_create_token.py
@@ -84,6 +84,11 @@
     },
 ]
 
+"""
+The purpose of this test class is to test the creation of a token (from create_token.py) to ensure metadata in a decrypted token is nested/found in the correct level. create_token_v2 is used
+as v1 methods are intended to be dropped and the other tests only use methods that do not have a v2 implementation.
+"""
+
 
 class TestCreateToken(IntegrationTestCase):
     def test_payload_from_token(self):