From dbcc83f353d5644092dddc90dbdf2264ddd63a90 Mon Sep 17 00:00:00 2001
From: Paulocracy <36934614+Paulocracy@users.noreply.github.com>
Date: Mon, 1 Feb 2021 16:54:02 +0100
Subject: [PATCH] Enhance docstring

---
 .../create_reaction_id_to_dG0_mapping_json.py             | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/publication_runs/ecoli_models/create_reaction_id_to_dG0_mapping_json.py b/publication_runs/ecoli_models/create_reaction_id_to_dG0_mapping_json.py
index 088825f..344a02c 100644
--- a/publication_runs/ecoli_models/create_reaction_id_to_dG0_mapping_json.py
+++ b/publication_runs/ecoli_models/create_reaction_id_to_dG0_mapping_json.py
@@ -30,9 +30,15 @@ def create_reaction_id_to_dG0_mapping_json(model: cobra.Model, json_path: str) -
     lets the Equilibrator API calculate the dG0 values for each reaction using
     the MetaNetX IDs for the metabolites.
 
+    This function is specifically written for the E. coli models used in CommModelPy's
+    publication as its selection of dG0 values is based on BiGG identifiers and as it
+    contains specific dG0 corrections for special reactions as referenced in the
+    comments of this function.
+    However, the general basis of this function can be easily adapted for other types of models.
+
     Arguments:
     * model: cobra.Model ~ The cobrapy model instance for which the dG0 mapping shall be created.
-    * json_path: str ~
+    * json_path: str ~ The path to the dG0 JSON that is going to be created.
 
     Output:
     * No variable but a JSON file with the mapping at json_path