You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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
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
The text was updated successfully, but these errors were encountered: