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

Improve docs coverage with sclicheck #1612

Merged
merged 7 commits into from
Nov 28, 2022
Merged

Conversation

Gedochao
Copy link
Contributor

@Gedochao Gedochao commented Nov 25, 2022

This improves the coverage of code included in our docs with the following

  • markdown code blocks are now handled on par with scala and java (so that markdown examples can be compiled and tested)
  • code blocks with >3 backticks are now supported (which also enables nesting code blocks in markdown examples)
  • some docs have been skipped until now, as they didn't include md or bash code blocks, but they still did have stuff to be compiled and tested (i.e. using-directives.md)
  • the docs root folder is now included in sclicheck.DocTests
▶ ./mill -i docs-tests.test 'sclicheck.DocTests.root*'
(...)
sclicheck.DocTests:
  + root getting_started 18.253s
  + root release_notes 0.007s
  • the reference docs folder is now included in sclicheck.DocTests
▶ ./mill -i docs-tests.test 'sclicheck.DocTests.reference*'
(...)
sclicheck.DocTests:
  + reference scala-command/index 0.129s
sclicheck.SclicheckTests:
sclicheck.GifTests:

@Gedochao Gedochao merged commit 1c86072 into VirtusLab:main Nov 28, 2022
@Gedochao Gedochao deleted the tweak-sclicheck branch November 28, 2022 14:26
@Gedochao Gedochao added documentation Improvements or additions to documentation internal Internal or build-related changes labels Nov 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal Internal or build-related changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants