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

documentation: updated example image (fixes #111) #270

Merged
merged 3 commits into from
Apr 3, 2024
Merged

Conversation

TrapinchO
Copy link
Contributor

I can get a larger image if necessary.

@zkat
Copy link
Owner

zkat commented Jul 16, 2023

I would prefer a larger image, and also one that shows off the error linkification

@TrapinchO
Copy link
Contributor Author

Increased image size as requested.

I am unsure what do you mean by the linkification. Do you want me to change the link text in the example (to show "link" or something similar instead) or to update code_linking.png?
Sadly my command line doesn't seem to be able to display links like that (I am on Windows), so I can't show it off.

@zkat
Copy link
Owner

zkat commented Jul 25, 2023

@TrapinchO the new Windows Terminal supports the feature:

image

@TrapinchO
Copy link
Contributor Author

I meant link tooltip, as seen on the current code_linking image.

I am afraid I don't understand what you want me to do. The error already includes a url. The other image is large enough and is about a different error.

@zkat
Copy link
Owner

zkat commented Jul 28, 2023

The problem is that it's displaying a URL at all. It should show the dashed underline instead.

@TrapinchO
Copy link
Contributor Author

This is the best I got to, no underline (url("(link)")). Cannot test whether it works due to windows terminal.
img

I would like to note that replacing docsrs with a string seems to display it whole and not just (link) and the documentation doesn't seem to show how to hide the link.

@willbush
Copy link
Contributor

willbush commented Apr 1, 2024

Was thinking to make the same PR, but I see this is already made. I can make an image and share here or make another PR if you want?

Seems the <img alt="..."> in the readme should change too. And I noticed lib.rs has a copy of the readme. I tried replacing it with #![doc = include_str!("../README.md")], but then tests started failing so I'm guessing that's why.

@TrapinchO
Copy link
Contributor Author

I have no problem with either. If you post it, I will update the pr, but feel free to open a fresh one.

@willbush
Copy link
Contributor

willbush commented Apr 2, 2024

single-line-example

Here you go. The underline on oops::my::bad (link) only shows up when I mouse over it, at least on Alacritty terminal in Linux. I had to zoom way in to get the resolution higher, mouse over the link, and take the screenshot with grim, and then crop the result in gimp.

@zkat
Copy link
Owner

zkat commented Apr 3, 2024

This latest one looks good to me, thanks :)

also update image alt text
Copy link
Owner

@zkat zkat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perfect, thank you all!

@zkat zkat merged commit 7b42b12 into zkat:main Apr 3, 2024
14 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants