update the 2.2.0 docs

HDRUK · Jan 31, 2024 · 2121c7d · 2121c7d
1 parent 3ca25a0
commit 2121c7d
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/docs/HDRUK/2.2.0.md b/docs/HDRUK/2.2.0.md
@@ -8,6 +8,7 @@ System dataset identifier
 | Dataset identifier | True       | Uuidv4 |
 
 Examples: 
+
    * ['226fb3f1-4471-400a-8c39-2b66d46a39b6', 'https://web.www.healthdatagateway.org/dataset/226fb3f1-4471-400a-8c39-2b66d46a39b6']
 
 
@@ -20,6 +21,7 @@ Dataset metadata version
 | Dataset Version | True       | Semver |
 
 Examples: 
+
    * 1.1.0
 
 
@@ -94,6 +96,7 @@ Title of the dataset limited to 150 characters. It should provide a short descri
 | Title   | True       | OneHundredFiftyCharacters |
 
 Examples: 
+
    * ['North West London COVID-19 Patient Level Situation Report']
 
 
@@ -106,6 +109,7 @@ Provide a clear and brief descriptive signpost for researchers who are searching
 | Dataset Abstract | True       | AbstractText |
 
 Examples: 
+
    * CPRD Aurum contains primary care data contributed by General Practitioner (GP) practices using EMIS Web® including patient registration information and all care events that GPs have chosen to record as part of their usual medical practice.
 
 
@@ -193,6 +197,7 @@ Please provide a valid email address that can be used to coordinate data access
 | Contact Point | True       | EmailAddress |
 
 Examples: 
+
    * [email protected]
 
 
@@ -227,6 +232,7 @@ All HDR UK registered datasets should either have a Digital Object Identifier (D
 | Digital Object Identifier | False      | Doi    |
 
 Examples: 
+
    * 10.3399/bjgp17X692645
 
 
@@ -239,6 +245,7 @@ Placeholder for dataset type
 | Datasetype | True       | DatasetType |
 
 Examples: 
+
    * ['']
 
 
@@ -251,6 +258,7 @@ Placeholder for dataset sub-type
 | Datasetype | True       | DatasetType |
 
 Examples: 
+
    * ['']
 
 
@@ -294,6 +302,7 @@ Please provide any media associated with the Gateway Organisation using a valid
 | Associated Media | False      | CommaSeparatedValues |
 
 Examples: 
+
    * PDF Document that describes study protocol
 
 
@@ -306,6 +315,7 @@ Please complete only if the dataset is part of a group or family
 | Group   | False      | CommaSeparatedValues |
 
 Examples: 
+
    * Hospital Episodes Statistics datasets (A&E, APC, OP, AC MSDS).
 
 
@@ -656,6 +666,7 @@ Please provide a brief description of the data access services that are availabl
 | Access Service | False      | LongDescription |
 
 Examples: 
+
    * https://cnfl.extge.co.uk/display/GERE/Research+Environment+User+Guide
 
 
@@ -827,6 +838,7 @@ Please select one of the following statistical populations for you observation
 | Statistical Population | True       | StatisticalPopulationConstrained |
 
 Examples: 
+
    * PERSONS
 
 

diff --git a/hdr_schemata/utils/create_markdown.py b/hdr_schemata/utils/create_markdown.py
@@ -54,8 +54,8 @@ def json_to_markdown(structure,level=2):
         description = field.pop('description')
         examples = field.pop('examples')
         if examples:
-            examples = "\n".join(['   * '+str(x) for x in examples])
-            examples = "Examples: \n" + examples
+            examples = "\n".join(['  * '+str(x) for x in examples])
+            examples = "Examples: \n\n " + examples
         else:
             examples = ""
 
@@ -75,6 +75,7 @@ def json_to_markdown(structure,level=2):
 {examples}
 
 '''
+
         if subItems:
             md += json_to_markdown(subItems,level=level+1)