From 7bdd3f347b2bdcd41ec4bf7bea2716dc2faf86f3 Mon Sep 17 00:00:00 2001
From: Tom Russell <tom.russell@ouce.ox.ac.uk>
Date: Mon, 25 Mar 2024 11:03:25 +0000
Subject: [PATCH] Docstring descriptions for scripts

---
 scripts/generate_datapackage_json.py | 5 +++++
 scripts/published_metadata.py        | 6 ++++++
 2 files changed, 11 insertions(+)

diff --git a/scripts/generate_datapackage_json.py b/scripts/generate_datapackage_json.py
index c497048..21fe17b 100644
--- a/scripts/generate_datapackage_json.py
+++ b/scripts/generate_datapackage_json.py
@@ -1,3 +1,8 @@
+"""Generate datapackage.json for full dataset
+
+Run as the final data-generation step in the Snakemake workflow.
+"""
+
 from collections import defaultdict
 import json
 from operator import itemgetter
diff --git a/scripts/published_metadata.py b/scripts/published_metadata.py
index f43fa45..cb4e812 100644
--- a/scripts/published_metadata.py
+++ b/scripts/published_metadata.py
@@ -1,3 +1,9 @@
+"""Generate CSV of Zenodo records published
+
+Run outside of the Snakemake workflow, as occasional job to record the
+publication of datasets.
+"""
+
 import csv
 import os
 import time