Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
crupley opened this issue Jan 7, 2019 · 1 comment

Comments

@crupley
Copy link
Contributor

crupley commented Jan 7, 2019

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
Copy link
Contributor Author

crupley commented Jan 7, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants