Fixes incorrect references to crate::shutdown::Shutdown in documentation - #14
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR corrects documentation references for graceful shutdown configuration, ensuring links point to the actual ShutdownConfig type (and its “Triggers” section) instead of an incorrect Shutdown reference, and aligns the README’s stated MSRV with the workspace rust-version.
Changes:
- Fixes the fairings guide link to point to
shutdown::ShutdownConfigtriggers on docs.rs. - Fixes an internal rustdoc link in
Shutdown’s docs to referenceShutdownConfig#triggers. - Updates the README MSRV badge to
1.88.0+to matchCargo.toml’srust-version = "1.88.0".
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| website/docs/08-fairings.md | Updates docs.rs link for “shutdown is triggered” to the correct ShutdownConfig#triggers target. |
| README.md | Updates the MSRV badge to match the workspace rust-version. |
| core/lib/src/shutdown/handle.rs | Fixes rustdoc link for “automatic triggers” to point to ShutdownConfig#triggers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
No description provided.