search

ocaml-community / yojson

Low-level JSON parsing and pretty-printing library for OCaml
https://ocaml-community.github.io/yojson/
BSD 3-Clause "New" or "Revised" License
322 stars 58 forks source link

Homepage of documentation missing several useful submodules #44

Open typesanitizer opened 6 years ago

typesanitizer commented 6 years ago

IMHO, as a new user, it would be great to have a short description (say 1 or 2 sentences) on the documentation homepage of what each module does. Currently there are no entries in the table for Basic, Raw, Safe and Util. That way, one can get a quick at-a-glance comparison between the different modules without diving into each one from the Yojson page and remembering which one does what.

If you don't want to put this information on the documentation homepage, you could add it to the Yojson module page.

Leonidas-from-XIV commented 3 years ago

Is this still a problem with the new API documentation generated at https://ocaml-community.github.io/yojson/ ?