Add comments to generated files.

bids-standard · Sep 3, 2020 · a6fa705 · a6fa705 · yarikoptic · Sep 3, 2020
1 parent f5ad3cb
commit a6fa705
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/src/99-appendices/04-entity-table.md b/src/99-appendices/04-entity-table.md
@@ -1,3 +1,7 @@
+<!--
+  This file is autogenerated based on the src/schema.  DO NOT EDIT DIRECTLY.
+  Follow https://github.com/bids-standard/bids-specification/blob/master/CONTRIBUTING.md#updating-the-schema
+-->
 # Appendix IV: Entity table
 
 This section compiles the entities (key-value pairs) described throughout this

diff --git a/src/99-appendices/09-entities.md b/src/99-appendices/09-entities.md
@@ -1,3 +1,7 @@
+<!--
+  This file is autogenerated based on the src/schema.  DO NOT EDIT DIRECTLY.
+  Follow https://github.com/bids-standard/bids-specification/blob/master/CONTRIBUTING.md#updating-the-schema
+-->
 # Appendix IX: Entities
 
 This section compiles the entities (key-value pairs) described throughout this

diff --git a/tools/bids_schema.py b/tools/bids_schema.py
@@ -201,6 +201,10 @@ def save_entities(schema_path, out_file):
     schema = load_schema(schema_path)
     entities = schema['entities']
     intro_text = """\
+<!--
+  This file is autogenerated based on the src/schema.  DO NOT EDIT DIRECTLY.
+  Follow https://github.com/bids-standard/bids-specification/blob/master/CONTRIBUTING.md#updating-the-schema
+-->
 # Appendix IX: Entities
 
 This section compiles the entities (key-value pairs) described throughout this
@@ -409,6 +413,10 @@ def save_entity_table(schema_path, out_file, entities_file='09-entities.md'):
     tables = make_entity_table_markdown(schema_path)
 
     intro_text = """\
+<!--
+  This file is autogenerated based on the src/schema.  DO NOT EDIT DIRECTLY.
+  Follow https://github.com/bids-standard/bids-specification/blob/master/CONTRIBUTING.md#updating-the-schema
+-->
 # Appendix IV: Entity table
 
 This section compiles the entities (key-value pairs) described throughout this