Scala3doc: Snippets validation and results #12
romanowski
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
From blogpost
Good documentation requires examples, and without proper tooling, those snippets can get outdated really quickly. This is where mdoc (or tut in the past) comes into play by compiling examples against the latest code.
Integration of such functionality into Scala3doc will provide some new benefits. First, we will be able to validate the snippets from static docs and docstrings. Furthermore, we can analyse the compilation artefacts to enhance API by, e.g. providing links to all examples where a given class is used or by enhancing HTML that snippets are compiled with links to API pages.
Beta Was this translation helpful? Give feedback.
All reactions