docs: update crate references for consistency in documentation #440
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
wmmc88
requested review from
Copilot and
leon-xd
and removed request for
Copilot
leon-xd
previously approved these changes
Aug 4, 2025
Contributor
leon-xd
left a comment
leon-xd
left a comment
There was a problem hiding this comment.
thanks for getting this done!
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request standardizes documentation references across multiple crates in the Windows Driver Kit (WDK) project. The changes focus on improving consistency in how crate names are referenced in documentation comments and ensuring proper linking formats.
Key changes include:
- Converting hardcoded crate names to use Rust's
[crate]link format for better navigation - Standardizing
wdk-sysreferences to use the correctwdk_sysnaming convention with HTML links - Adding explicit crate context to documentation for clarity
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| crates/wdk/src/lib.rs | Updated wdk-sys reference to use correct wdk_sys naming |
| crates/wdk-macros/src/lib.rs | Converted wdk-sys references to proper wdk_sys HTML links |
| crates/wdk-build/src/lib.rs | Replaced hardcoded crate names with [crate] link format |
| crates/cargo-wdk/src/main.rs | Replaced hardcoded crate names with [crate] link format |
Co-authored-by: Copilot <[email protected]> Signed-off-by: Melvin Wang <[email protected]>
hamzamust
approved these changes
Aug 5, 2025
leon-xd
approved these changes
Aug 5, 2025
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.
This pull request focuses on improving documentation consistency and clarity across multiple crates in the project. The main updates involve standardizing crate references in documentation comments, correcting links to use the appropriate Rust or HTML formats, and clarifying crate names for better readability and navigation.
Documentation consistency and crate references:
crates/cargo-wdk/src/main.rsandcrates/wdk-build/src/lib.rsto refer to the crate using the[crate]link format, improving consistency and navigation for users. [1] [2] [3] [4]wdk-sysin documentation comments to use the correctwdk_sysnaming and HTML link format incrates/wdk-macros/src/lib.rsandcrates/wdk/src/lib.rs, ensuring accurate and clickable documentation links. [1] [2] [3]