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

Migrate to mdoc #340

Merged
merged 2 commits into from
Apr 3, 2021
Merged

Migrate to mdoc #340

merged 2 commits into from
Apr 3, 2021

Conversation

valencik
Copy link
Member

@valencik valencik commented Apr 3, 2021

Resolves #339
This PR does a pretty naive migration of tut to mdoc.

Some differences in output:

tut

// unbroken text from a String
val cat = Doc.text("cat")
// cat: org.typelevel.paiges.Doc = Doc(...)

// same as text, but using .toString first
val pair = Doc.str((1, 2))
// pair: org.typelevel.paiges.Doc = Doc(...)

mdoc

// unbroken text from a String
val cat = Doc.text("cat")
// cat: Doc = Text(str = "cat")

// same as text, but using .toString first
val pair = Doc.str((1, 2))
// pair: Doc = Text(str = "(1,2)")

It looks like we weren't using the output of tut anywhere in the previous build?
Maybe I am missing something... 🤔

@codecov-io
Copy link

Codecov Report

Merging #340 (e1468d5) into master (60cd437) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #340   +/-   ##
=======================================
  Coverage   99.51%   99.51%           
=======================================
  Files           7        7           
  Lines         410      410           
  Branches       41       41           
=======================================
  Hits          408      408           
  Misses          2        2           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 60cd437...e1468d5. Read the comment docs.

@johnynek
Copy link
Collaborator

johnynek commented Apr 3, 2021

This is great. We don't use the tut output but we do verify that the examples in the markdown compile. That is the goal for us of using tut/mdoc.

Thanks for doing this!

@johnynek johnynek merged commit 9a1b045 into typelevel:master Apr 3, 2021
@ekrich
Copy link
Contributor

ekrich commented Apr 3, 2021

Ok, I will rebase later today.

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

Successfully merging this pull request may close these issues.

migrate to mdoc
4 participants