Mirror of forum.nim-lang.org

5140 :: Nim documentation like Go

• SebastianM (orginal) [2019-08-28T08:05:18+02:00] view original

  Hi guys,

  Is anyone familliar with Golang documentation?

  If you type go doc fmt Println in terminal you can get a small peace of information:

  func Println(a ...interface{}) (n int, err error)

  Println formats using the default formats for its operands and writes to standard output. Spaces are always added between operands and a newline is appended. It returns the number of bytes written and any write error encountered.

  right there in terminal.

  I found that nim does something similar with html (generates html from the module - nim doc) But is there a way to retreve information and view them in terminal just like in Go? Should I install any additional packages?

---

• Araq (orginal) [2019-08-28T08:12:41+02:00] view original

  I don't think we have such a tool.

---

• jiyinyiyong (orginal) [2019-08-29T05:50:05+02:00] view original

  curious how the types and snippets in the docs was created, written by hand?

  https://nim-lang.org/docs/sequtils.html

---

• miran (orginal) [2019-08-29T07:42:01+02:00] view original

  written by hand?

  Yes.

---

• miran (orginal) [2019-08-29T07:46:38+02:00] view original

  If you type go doc fmt Println in terminal you can get a small peace of information (...) right there in terminal.

  This nim plugin for Neovim gives you even better functionality, IMO. You don't have to type any special command in terminal, as you type it gives you code completion and you can see the whole documentation in a separate nvim window: see the video from its readme.

---