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

Homepage of documentation missing several useful submodules #44

Open
typesanitizer opened this issue Jul 24, 2017 · 1 comment
Open

Comments

@typesanitizer
Copy link

typesanitizer commented Jul 24, 2017

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
Copy link
Member

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

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

3 participants