-
Notifications
You must be signed in to change notification settings - Fork 891
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
Add more documentation for keyboard types #2811
Add more documentation for keyboard types #2811
Conversation
b14ade4
to
679534f
Compare
Could you resolve conflicts? |
src/keyboard.rs
Outdated
/// For instance, the "1" key above the "Q" key on a QWERTY keyboard will use this location. This | ||
/// invariant is also returned when the location of the key cannot be identified. | ||
/// | ||
/// ![Standard 1 key](https://raw.githubusercontent.com/rust-windowing/winit/master/images/keyboard_standard_1_key.svg) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since there's no neat workaround for rust-lang/rust#32104 still being unresolved, I guess linking to it through GitHub works fine for now. My gut tells me we should be linking to a tagged release rather than the master
branch, but linking to master
initially is fine. I did find a way to link to the local copy of the SVG first, and then fall back to the GitHub link (roughly <img alt="Standard 1 key" src="../../../../images/keyboard_standard_1_key.svg" onerror="this.src = 'https://raw.githubusercontent.com/rust-windowing/winit/master/images/keyboard_standard_1_key.svg'">
), but that wouldn't link the local version of the image if Winit's docs are built as a dependency, though I suppose instances where that would matter are exceedingly rare, if nonexistent.
While I'm sorely tempted to have one of us look into the SVG |
7812000
to
33f44fe
Compare
1280ef4
to
d965636
Compare
All svg files have been run through svgo in order to reduce file size
d965636
to
4219a91
Compare
CHANGELOG.md
if knowledge of this change could be valuable to usersThis PR adds documentation for some of the items introduced in #2662