Mirror of forum.nim-lang.org

5514 :: nim doc generates ugly output for const tables

• pmags (orginal) [2019-11-14T15:49:11+01:00] view original

  I'm finding that nim doc generates ugly output for tables declared as const, presumably because of the compile time expansion. To see what I mean, run nim doc on the following example and compare the the way the identical tables are displayed in the let and const sections:

  import tables
  const
    wonkyLookingTable* = {"a": 1, "b": 2, "c": 3}.toTable
  let
    betterLookingTable* = {"a": 1, "b": 2, "c": 3}.toTable
  Run

  Is there any way to look around this? Is there some flag I can pass to nim doc to tell it to document const tables without evaluating them?

---

• juancarlospaco (orginal) [2019-11-14T16:46:35+01:00] view original

  const are compile-time evaluated by definition.

---

• pmags (orginal) [2019-11-14T16:51:29+01:00] view original

  I understand what const does in terms of compiling a nim program, but I'm looking for a way to deal with the ugly output of nim doc itself. I guess the problem is that nim doc actually compiles each module rather than just parsing?

---

• juancarlospaco (orginal) [2019-11-14T17:23:00+01:00] view original

  I dont understand what you mean, but basically it is showing you what the const literally is.

  You can use macro to make a custom nnkCommentStmt.

  
    import macros
    macro docustom(): auto = newCommentStmtNode("This is my custom Doc")
    expandMacros: docustom()
  Run

---

• mratsim (orginal) [2019-11-14T18:26:10+01:00] view original

  you can use "when defined(nimdoc)" to do specific thing on nimdoc.

  In general, compile-time tables and compile-time object variants are ugly when printing due to how it's represented in the VM memory. Unfortunately I think this is a hard problem.

---