There's a gist of code available (replace
scribblings/*, since gists apparently can't have directories). If you get that setup properly and do
raco pkg install, you'll see output like in scribble defmodulelang duplicate tag · GitHub.
I wanted to create a multi-page document for a large tool (it has 2 languages and a CLI, and the languages re-export chunks of a library). However, even just stubbing out some basic pages and adding
defmodulelang* in the full-version, but there was no difference) gives the warnings in the log.
- How do I avoid it?
I have read 4.2.2 Documenting Modules which says
Besides generating text, unless #:no-declare appears as an option, this form expands to a use of declare-exporting with module-paths; the #:use-sources clause, if provided, is propagated to declare-exporting. Consequently, defmodule should be used at most once in a section without #:no-declare, though it can be shadowed with defmodules in sub-sections. Use #:no-declare form when you want to provide a more specific list of modules (e.g., to name both a specific module and one that combines several modules) via your own declare-exporting declaration
But the second
defmodulelang is in a document inserted via
include-section so it should be in a sub-section, no? Or have I misunderstood something?
Somewhat relatedly, which I or a mod can split off to a new topic if desired: since the lang re-exports things original presented from the library, how can I reasonably document the bindings in both places? One option is to say "lang re-exports all of X, Y, Z" and conversely "these bindings are provided by lib X and lang." But I saw
Use #:use-sources sparingly, but it is needed when
- bindings are documented as originating from a module M, but the bindings are actually re-exported from some module P; and
- other documented modules also re-export the bindings from P, but they are documented as re-exporting from M.
and this is just confusing enough for me that I haven't tried to draw the ideas yet to figure out if I need it or how to use it.