Skip to content

switch from tut to mdoc (for checking code snippets) #1815

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

Closed
SethTisue opened this issue Nov 12, 2020 · 1 comment · Fixed by #1838
Closed

switch from tut to mdoc (for checking code snippets) #1815

SethTisue opened this issue Nov 12, 2020 · 1 comment · Fixed by #1838

Comments

@SethTisue
Copy link
Member

we use tut (https://github.com/tpolecat/tut, http://tpolecat.github.io/tut/) to actually run code snippets and make sure they compile and run and give the expected result. this happens during PR validation

tut is considered deprecated and the author (Rob Norris / @tpolecat) suggests everyone switch to @olafurpg's mdoc (https://github.com/scalameta/mdoc), which didn't exist yet at the time we adopted tut in this repo

so that's a possible todo at some point. when? well for one thing, it seems unlikely tut will add Scala 3 support.

@SethTisue
Copy link
Member Author

mdoc support for Scala 3 is in progress, or soon to be in progress anyway: scalameta/mdoc#347

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

Successfully merging a pull request may close this issue.

1 participant