diff options
| author | Timothee Cour <timothee.cour2@gmail.com> | 2021-01-13 19:09:00 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-13 19:09:00 -0800 |
| commit | 7f67c593c11ea4d2c5228eb983c8f1e2cafee0e4 (patch) | |
| tree | 42de979811690d3f2a726b2833cc6310f31b2311 | |
| parent | fee5fbc722295a49aad4980a915ff2d41c1fa701 (diff) | |
| download | Nim-7f67c593c11ea4d2c5228eb983c8f1e2cafee0e4.tar.gz | |
improve formatting of error message when runnableExamples fails (#16677)
| -rw-r--r-- | compiler/docgen.nim | 7 |
1 files changed, 6 insertions, 1 deletions
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]) |