From 7f67c593c11ea4d2c5228eb983c8f1e2cafee0e4 Mon Sep 17 00:00:00 2001 From: Timothee Cour Date: Wed, 13 Jan 2021 19:09:00 -0800 Subject: [PATCH] improve formatting of error message when runnableExamples fails (#16677) --- compiler/docgen.nim | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/compiler/docgen.nim b/compiler/docgen.nim index f07adc428..6352ef583 100644 --- a/compiler/docgen.nim +++ b/compiler/docgen.nim @@ -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])