From b749ea876b02a4a84379b6c145fa3a2f2cc41751 Mon Sep 17 00:00:00 2001
From: amar jandu <amarjandu@specterbyte.com>
Date: Mon, 18 Oct 2021 13:48:32 -0700
Subject: [PATCH] Fix: EBNF for sources was deleted (#3562)

Regression from: b4075d44
---
 environment.py | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/environment.py b/environment.py
index 99421f60af..d790185ce6 100644
--- a/environment.py
+++ b/environment.py
@@ -56,6 +56,32 @@ def env() -> Mapping[str, Optional[str]]:
         #
         # The first catalog listed is the default catalog.
         #
+        # A source represents a TDR dataset, TDR snapshot, or canned staging
+        # area to index. Each source is a string matching the following EBNF grammar:
+        #
+        # source = TDR source | canned source ;
+        #
+        # TDR source = 'tdr:', Google Cloud project name,
+        #              ':', ( 'dataset' | 'snapshot' ),
+        #              '/', TDR dataset or snapshot name,
+        #              ':', [ UUID prefix [ '/', Partition prefix length ] ] ;
+        #
+        # canned source = 'https://github.com',
+        #                 '/', owner,
+        #                 '/', repo,
+        #                 '/tree/', ref,
+        #                 ['/', path] ;
+        #                 ':', [ UUID prefix [ '/', Partition prefix length ] ] ;
+        #
+        # `ref` can be a branch, tag, or commit SHA. If `ref` contains special
+        # characters like `/`, '?` or `#` they must be URL-encoded.
+        #
+        # Examples:
+        #
+        # tdr:broad-jade-dev-data:snapshot/hca_mvp:2
+        # tdr:broad-jade-dev-data:dataset/hca_mvp:2/1
+        # https://github.com/HumanCellAtlas/schema-test-data/tree/de355ca/tests:2
+        #
         'AZUL_CATALOGS': None,
 
         # The Account ID number for AWS