From e1fb18b9d4a3b4ab9783f58d78ff384141567a42 Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Tue, 23 Nov 2021 11:49:32 +0300
Subject: Update documentation for functions

Issue:
https://github.com/genenetwork/gn-gemtext-threads/blob/main/topics/gn1-migration-to-gn2/partial-correlations.gmi

* Document functions for posterity.
---
 gn3/db/correlations.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'gn3')

diff --git a/gn3/db/correlations.py b/gn3/db/correlations.py
index 7daff87..5c3e7b8 100644
--- a/gn3/db/correlations.py
+++ b/gn3/db/correlations.py
@@ -408,6 +408,10 @@ def build_query_sgo_lit_corr(
     """
     Build query for `SGO Literature Correlation` data, when querying the given
     `temp_table` temporary table.
+
+    This is a partial migration of the
+    `web.webqtl.correlation.CorrelationPage.fetchAllDatabaseData` function in
+    GeneNetwork1.
     """
     return (
         (f"SELECT {db_type}.Name, {temp_table}.value, " +
@@ -424,6 +428,14 @@ def build_query_sgo_lit_corr(
         2)
 
 def build_query_tissue_corr(db_type, temp_table, sample_id_columns, joins):
+    """
+    Build query for `Tissue Correlation` data, when querying the given
+    `temp_table` temporary table.
+
+    This is a partial migration of the
+    `web.webqtl.correlation.CorrelationPage.fetchAllDatabaseData` function in
+    GeneNetwork1.
+    """
     return (
         (f"SELECT {db_type}.Name, {temp_table}.Correlation, " +
          f"{temp_table}.PValue, " +
-- 
cgit v1.2.3