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

Add documentation for List, list_spacing #250

Open
joelburget opened this issue Aug 2, 2021 · 0 comments
Open

Add documentation for List, list_spacing #250

joelburget opened this issue Aug 2, 2021 · 0 comments

Comments

@joelburget
Copy link

Without documentation it's difficult for me to understand the List constructor of block and the list_spacing type. In particular, I would expect List to hold 'attr block list (rather than list list).

The closest to an explanation I found is this block: https://github.com/ocaml/omd/blob/d38041aa00ffad3b41f14d72c048ad1d9d359cbd/src/html.ml#L150-L175

It looks to me like each item in the outer list gets mapped to an li, and items in the inner list get mapped to either an inline or block element, but the logic is a bit confusing. I'd appreciate a note in the docs to clear this up (including how this is parsed) 🙂

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

No branches or pull requests

2 participants