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

Book Of Doobie - Text doesn't correspond to code example #1288

Closed
LLCampos opened this issue Oct 13, 2020 · 5 comments
Closed

Book Of Doobie - Text doesn't correspond to code example #1288

LLCampos opened this issue Oct 13, 2020 · 5 comments

Comments

@LLCampos
Copy link
Contributor

In here, there's the following snippet of code:

sql"select name from country"
  .query[String]    // Query0[String]
  .to[List]         // ConnectionIO[List[String]]
  .transact(xa)     // IO[List[String]]
  .unsafeRunSync    // List[String]
  .take(5)          // List[String]
  .foreach(println) // Unit
// Afghanistan
// Netherlands
// Netherlands Antilles
// Albania
// Algeria

But the text that follows does not correspond to this example, e.g., it mentions .unique, which is not called in the snippet.

@jatcwang
Copy link
Collaborator

Hi thanks for reporting an issue, but I think in this case it's intentional. You can see that mention of unique etc follows "Similar methods are:"

Perhaps it'd be clearer if those were sublist items? Would you like to make a PR to help make it clearer? :)

@LLCampos
Copy link
Contributor Author

LLCampos commented Oct 14, 2020

Ok, checked this out and it seems that in the markdown file, those are sublist items indeed!

I guess the issue then is with the docs generation (through mdoc)? When I have time I'll have a go and check if this is a bug in mdoc.

@jatcwang
Copy link
Collaborator

Possibly a bug in Paradox. I'm using mdoc for my other project documentation and sublists work fine there.

@LLCampos
Copy link
Contributor Author

Yes, it's a bug in Paradox. Already raised an issue on its repo, so I guess this one can be closed.

@jatcwang
Copy link
Collaborator

Thank you @LLCampos :)

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

No branches or pull requests

2 participants