Skip to content

Commit dcf52f3

Browse files
author
james
committed
improve lists in metadata section
1 parent f5ae008 commit dcf52f3

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/codeql/query-help-markdown.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -182,8 +182,8 @@ def subprocess_run(cmd):
182182
get_query_metadata('problem.severity', meta, queryfile) + "\n"
183183
query_precision = "Precision: " + \
184184
get_query_metadata('precision', meta, queryfile) + "\n"
185-
query_tags = "Tags: " + \
186-
get_query_metadata('tags', meta, queryfile) + "\n"
185+
query_tags = "Tags:\n - " + \
186+
get_query_metadata('tags', meta, queryfile).replace(" ", "\n - ") + "\n"
187187

188188
# Build a link to the query source file for display in the query help
189189
if "go" in prefix_repo_nwo(queryfile):
@@ -196,20 +196,20 @@ def subprocess_run(cmd):
196196
transform_link + ")\n"
197197

198198
if queryfile in code_scanning_queries:
199-
cs_suites = lang +'-code-scanning.qls '
199+
cs_suites = ' - ' + lang +'-code-scanning.qls\n'
200200
else:
201201
cs_suites = ""
202202
if queryfile in security_extended_queries:
203-
se_suites = lang + '-security-extended.qls '
203+
se_suites = ' - ' + lang + '-security-extended.qls\n'
204204
else:
205205
se_suites = ""
206206
if queryfile in security_and_quality_queries:
207-
sq_suites = lang + '-security-and-quality.qls '
207+
sq_suites = ' - ' +lang + '-security-and-quality.qls\n'
208208
else:
209209
sq_Suites = ""
210210

211211
if queryfile in code_scanning_queries or queryfile in security_extended_queries or queryfile in security_and_quality_queries:
212-
suites_list = "Query suites: " + cs_suites + se_suites + sq_suites + "\n"
212+
suites_list = "Query suites:\n" + cs_suites + se_suites + sq_suites
213213
else:
214214
suites_list = ""
215215

0 commit comments

Comments
 (0)