Merged
Conversation
jaredoconnell
approved these changes
Jan 17, 2023
Contributor
jaredoconnell
left a comment
jaredoconnell
left a comment
There was a problem hiding this comment.
Fixes and improvements to documentation are appreciated!
I tested this locally and it looks good in the files I tested.
longmathemagician
approved these changes
Jan 26, 2023
Contributor
longmathemagician
left a comment
longmathemagician
left a comment
There was a problem hiding this comment.
This is a huge improvement even though a few more fixes are needed elsewhere.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I went over all the documentation and fixed every broken link I could find. It's not perfect, there are still broken links that are caused by code that is not in this repo (
kurbo,piet,im) but obviously those will need to be fixed elsewhere.The strategy here was to resolve broken links by changing the URL link to a rustdoc managed symbol based link. This method supports the link appearing at different levels of nesting (which URL links never did) and also has the benefit of sometimes being automatically detected when broken. Not every link was converted, but the remaining URL links still work.
Another thing to note is that when a symbol is in scope then the link doesn't have to be defined at all.
/// If the [`Widget`] trait is in scope, then that link will just work.