Better link for prepare_windows docs #10142
Merged
Conversation
This file contains 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
alice-i-cecile
added
C-Docs
alice-i-cecile
approved these changes
Oct 16, 2023
alice-i-cecile
added
the
S-Ready-For-Final-Review
mockersf
approved these changes
Oct 16, 2023
ameknite
pushed a commit
to ameknite/bevy
that referenced
this pull request
Nov 6, 2023
# Objective While pointing someone to the profiling doc, I saw a source link and thought "hm, I wonder if that link is up-to-date?" After clicking on it, I realized that it wasn't even attempting to point to the right line -- probably a good idea since that would be super prone to breakage. However, the system being referenced is pub and the docs are on docs.rs, so we can just link there. This gets the content straight onto the user's screen. ## Solution Change source link to docs link ## Note This is slightly awkward in that the profiling docs themselves aren't rendered anywhere and just live in the repo. It does feel more correct to link to in-repo code on the same branch.
rdrpenguin04
pushed a commit
to rdrpenguin04/bevy
that referenced
this pull request
Jan 9, 2024
# Objective While pointing someone to the profiling doc, I saw a source link and thought "hm, I wonder if that link is up-to-date?" After clicking on it, I realized that it wasn't even attempting to point to the right line -- probably a good idea since that would be super prone to breakage. However, the system being referenced is pub and the docs are on docs.rs, so we can just link there. This gets the content straight onto the user's screen. ## Solution Change source link to docs link ## Note This is slightly awkward in that the profiling docs themselves aren't rendered anywhere and just live in the repo. It does feel more correct to link to in-repo code on the same branch.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Objective
While pointing someone to the profiling doc, I saw a source link and thought "hm, I wonder if that link is up-to-date?"
After clicking on it, I realized that it wasn't even attempting to point to the right line -- probably a good idea since that would be super prone to breakage.
However, the system being referenced is pub and the docs are on docs.rs, so we can just link there. This gets the content straight onto the user's screen.
Solution
Change source link to docs link
Note
This is slightly awkward in that the profiling docs themselves aren't rendered anywhere and just live in the repo. It does feel more correct to link to in-repo code on the same branch.