Skip to content

Commit 213bb51

Browse files
benjaminleightonjeremyh
authored andcommittedSep 8, 2020
Better readme comments
1 parent 26535f3 commit 213bb51

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed
 

‎README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,15 @@ You can alter default [Flask](http://flask.pocoo.org/docs/1.0/config/) or
129129
# Default product to display (picks first available)
130130
CUBEDASH_DEFAULT_PRODUCTS = ('ls8_nbar_albers', 'ls7_nbar_albers')
131131

132-
# Limited regex syntax and group name pairs can be used to group matches on product name.
132+
# Limited regex syntax to match product names with a user-defined group.
133+
# Pairs of regex,group are ";" separated. Regex and group are "," separated.
134+
# As such ";" and "," can't be used in the regexs.
135+
# eg ".albers., Albers projection; level1, Level 1 products"
136+
# If re.search(regex, product name) then return the corresponding group.
137+
# If CUBEDASH_PRODUCT_GROUP_BY_REGEX string parses then regex matching will be used in place of CUBEDASH_PRODUCT_GROUP_BY_FIELD.
138+
# If CUBEDASH_PRODUCT_GROUP_BY_REGEX string is malformed an error will be logged and we default back to CUBEDASH_PRODUCT_GROUP_BY_FIELD.
133139
# eg ".*albers.*,Albers projection;level1,Level 1 products"
134-
# regex and group name seperated with, and pairs thereof with ;
135-
# multiple regexs can match to target then same group but if multiple regexes match a product only the first group is assigned
136-
# if defined overrules CUBEDASH_PRODUCT_GROUP_BY_FIELD
137-
CUBEDASH_PRODUCT_GROUP_BY_REGEX = ".*albers.*,Albers projection;.*level1.*,Level 1 products"
140+
CUBEDASH_PRODUCT_GROUP_BY_REGEX = None
138141
# Which field should we use when grouping products in the top menu?
139142
CUBEDASH_PRODUCT_GROUP_BY_FIELD = 'product_type'
140143
# Ungrouped products will be grouped together in this size.

0 commit comments

Comments
 (0)
Please sign in to comment.