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

Pop-ups (previews) would ideally also use special formatting for code #1639

Closed
bernardosulzbach opened this issue Dec 25, 2022 · 2 comments · Fixed by #1640 or #1685
Closed

Pop-ups (previews) would ideally also use special formatting for code #1639

bernardosulzbach opened this issue Dec 25, 2022 · 2 comments · Fixed by #1640 or #1685

Comments

@bernardosulzbach
Copy link

I think it would be better if we had code formatting in the pop-ups (previews) shown when hovering a link to a function.

See in the image below how "value" and "fun" are written as if they were just text, which of course we can still read, but is somewhat confusing when everywhere else code entities are written in a monospaced font with a special background.

image

@josevalim
Copy link
Member

A PR is welcome!

@bernardosulzbach
Copy link
Author

No, it's not about the header, where there can be no ambiguity about what those words are and there is no other text.

I've highlighted the original image to make it completely clear where value and fun look just like plain English words in a sentence. Ideally, those would look like the some_fun you can see in the background, for both consistency and ease of reading.

image

Pinging @solar05 just in case.

@josevalim josevalim reopened this Dec 29, 2022
leandrocp added a commit to leandrocp/ex_doc that referenced this issue Mar 24, 2023
josevalim pushed a commit that referenced this issue Mar 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants