Update readme.md - fix link #2644
Closed
Conversation
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
tim-weis
reviewed
Sep 5, 2023
| @@ -3,7 +3,7 @@ | |||
| The [windows](https://crates.io/crates/windows) and [windows-sys](https://crates.io/crates/windows-sys) crates let you call any Windows API past, present, and future using code generated on the fly directly from the [metadata describing the API](https://github.com/microsoft/windows-rs/tree/master/crates/libs/bindgen/default) and right into your Rust package where you can call them as if they were just another Rust module. The Rust language projection follows in the tradition established by [C++/WinRT](https://github.com/microsoft/cppwinrt) of building language projections for Windows using standard languages and compilers, providing a natural and idiomatic way for Rust developers to call Windows APIs. | |||
|
|
|||
| * [Getting started](https://kennykerr.ca/rust-getting-started/) | |||
| * [Samples](https://github.com/microsoft/windows-rs/tree/0.52.0/crates/samples) | |||
| * [Samples](https://github.com/microsoft/windows-rs/tree/master/crates/samples) | |||
There was a problem hiding this comment.
This was changed in #2226 so that the Samples link on crates.io always refers to the corresponding sample code for any given version. This means the link in this repository's readme is usually ahead of its time and 404's.
The proposed change, however, makes matters worse: On crates.io, the Samples link will now practically always be out of sync with any published version.
There was a problem hiding this comment.
Yes, I think I just need to split the repo readme files so that each crate carries its own readme and the repo itself has a single non-published readme as we just keep having this same issue pop up repeatedly. 🤷♂️
|
Closing in favor of #2645. |
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.
What's this all about?
Fix broken link
Fixes: #0000 ⬅️ Be sure to refer to an existing issue here!