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.

Sign up for GitHub

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

Jump to bottom

Improve documentation formatting on hover #365

Open
3 tasks
ulugbekna opened this issue Jan 19, 2021 · 0 comments
Open
3 tasks

Improve documentation formatting on hover #365

ulugbekna opened this issue Jan 19, 2021 · 0 comments

Comments

@ulugbekna
Copy link
Collaborator

Currently, markdown documentation shown on hover has several flows, which we can track here:

  • Nested ocamldoc elements are wrongly translated into markdown, e.g.,

image

  • Add support for code references

  • (maybe) Make those code references expandable somehow, which would help with informal doc aliases, e.g.,
    when one hovers over Format.kasprintf, the doc says "same as asprintf ..." but now one has to somehow look up doc for asprintf, which is annoying.
@ulugbekna ulugbekna changed the title Improve documentation on hover Improve documentation formatting on hover Feb 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ulugbekna