Mirror of forum.nim-lang.org

5831 :: How to add a long usage string to cligen's help?

• enthus1ast (orginal) [2020-01-18T19:30:09+01:00] view original

  How can i add a large documentation string to cligen's help output?

---

• cblake (orginal) [2020-01-18T20:48:29+01:00] view original

  You might look at https://github.com/c-blake/lc for an example. That's kind of engineered around 80 terminal column outputs. You can also re-arrange which parts (help table or long doc) go where with the usage template. That uses initGen and dispatchGen, but the ideas are the same for dispatch. Feel free to raise an issue over at https://github.com/c-blake/cligen if you can't get it working.

---

• enthus1ast (orginal) [2020-01-18T21:16:34+01:00] view original

  Thank you cblake i got it to work now!

  dispatch(cli,  doc = """
    Foo
    baa
  """)
  Run

  before i tried:

  const help = "some help"
  dispatch(cli, doc = help)
  Run

  without noticing that not the content of the help string was printed but the variable name. It might be a good idea if that would also be possible.

---

• cblake (orginal) [2020-01-18T23:41:56+01:00] view original

  Well, that is indeed the lone open issue on the github repo...PRs for that are welcome if you/someone wants to try.

---

• enthus1ast (orginal) [2020-01-19T01:32:11+01:00] view original

  done a PR but not sure if this has unwanted side effects

---