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

Fix broken link in documentation #1345

Merged
merged 1 commit into from Dec 28, 2020
Merged

Fix broken link in documentation #1345

merged 1 commit into from Dec 28, 2020

Conversation

atsheehan
Copy link
Contributor

The link to the Window struct on the glutin index page is
broken. It looks for the struct in the top-level module but
it's defined in the window module.

This change prefixes the link with the window module name.

  • Tested on all platforms changed
  • Compilation warnings were addressed
  • cargo fmt has been run on this branch
  • cargo doc builds successfully
  • Added an entry to CHANGELOG.md if knowledge of this change could be valuable to users
  • Updated documentation to reflect any user-facing changes, including notes of platform-specific behavior
  • Created or updated an example program if it would help users understand this functionality

@atsheehan
Fix broken link in documentation
c372db2 
The link to the Window struct on the [glutin index page is
broken][0]. It looks for the Window struct in the top-level module but
it's defined in the `window` module.

This change prefixes the link with the window module name.

[0]: https://docs.rs/glutin/0.26.0/glutin/
chrisduerr
chrisduerr approved these changes Dec 28, 2020
View reviewed changes
Copy link
Contributor

@chrisduerr chrisduerr left a comment

Choose a reason for hiding this comment

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

Works @murarth.

@murarth murarth merged commit bab33a8 into rust-windowing:master Dec 28, 2020
@atsheehan atsheehan deleted the fix-doc-link branch February 21, 2023 02:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrisduerr chrisduerr chrisduerr approved these changes

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@atsheehan @chrisduerr @murarth