Mirror of forum.nim-lang.org

3126 :: Export docs? Submodules?

• Udiknedormin (orginal) [2017-08-26T22:18:22+02:00] view original

  It's certainly useful that entities can be exported. This way we can skip long paths. However, what actually happens is JUST passing an entity for visibility. No docs exporting, no module hiding. Which is quite weird for me.

  Why I think submodules would be useful?

  • better encapsulation
  • smaller files (git will thank you later)
  • better documentation pages

  Actually, it seems to me the solution would be pretty easy:

  • main modules -- let every package define which modules will it expose
  • submodules -- all the other modules are only visible is explicitly exported in these modules (and then use motation mainmodule.submodule)
  • visibility -- if a submodule is visible, its exposed entities are both in its docpage and its parent docpage, but in a separate section (possibly "from submodules", "reexporting" or something like that)

  So the question is: is there any possibility to provide a nice, encapsulated module tree without sacrificing docpages right now? Includes are not a good solution.

---

• dom96 (orginal) [2017-08-27T13:57:37+02:00] view original

  If I understand you correctly, you want the doc gen to show the documentation for exported modules inside the module that exports it?

---

• Udiknedormin (orginal) [2017-08-28T21:34:05+02:00] view original

  More precisely: for exported entities. Meaning:

  # foo.nim
  const sth* = 5
  const oth = 4
  
  # bar.nim
  from foo import sth
  export sth
  Run

  bar.nim docs should include sth but not oth. Also, it should be explicitly marked as exported in the docs unless foo.nim is package-private module.

---

• jiyinyiyong (orginal) [2020-09-15T04:50:37+02:00] view original

  Any updates on this?

  I use re-exporting quite frequently in my projects, now I don't know how to generate docs. Turned out I need type-based generated more than my handwritten docs.

---