improve formatting of error message when runnableExamples fails (#16677)

This commit is contained in:
Timothee Cour
2021-01-13 19:09:00 -08:00
committed by GitHub
parent fee5fbc722
commit 7f67c593c1

View File

@@ -57,6 +57,11 @@ type
PDoc* = ref TDocumentor ## Alias to type less.
proc prettyString(a: object): string =
# xxx pending std/prettyprint refs https://github.com/nim-lang/RFCs/issues/203#issuecomment-602534906
for k, v in fieldPairs(a):
result.add k & ": " & $v & "\n"
proc presentationPath*(conf: ConfigRef, file: AbsoluteFile, isTitle = false): RelativeFile =
## returns a relative file that will be appended to outDir
let file2 = $file
@@ -480,7 +485,7 @@ proc runAllExamples(d: PDoc) =
"docCmd", group.docCmd,
]
if os.execShellCmd(cmd) != 0:
quit "[runnableExamples] failed: generated file: '$1' group: '$2' cmd: $3" % [outp.string, $group[], cmd]
quit "[runnableExamples] failed: generated file: '$1' group: '$2' cmd: $3" % [outp.string, group[].prettyString, cmd]
else:
# keep generated source file `outp` to allow inspection.
rawMessage(d.conf, hintSuccess, ["runnableExamples: " & outp.string])