TransmogrifAI icon indicating copy to clipboard operation
TransmogrifAI copied to clipboard

Add package which gives ability compile check and execute code provided in documentation

Open crupley opened this issue 5 years ago • 1 comments

Problem Outdated code examples or even mistakes in syntax in documentation can cause confusion when users do not get the same results when trying to run the code shown.

Solution

  • Would like to add a dependency for scalatest mdoc which can generate documentation with compiled and executed scala code.
  • This will also require updating any documentation where the project would be taking advantage of this feature.

Alternatives One alternative is tut which has similar functionality, but does not provide as clear error messages when the documentation code fails to compile.

Additional context none

crupley avatar Jan 07 '19 19:01 crupley

May be an issue that mdoc only supports scala 2.12 currently.

crupley avatar Jan 07 '19 20:01 crupley