Remove doctests from uv-keyring#18919
Merged
Merged
Conversation
- Replace `keyring::` with `uv_keyring::` in doctests (the crate was vendored/renamed but doc examples still referenced the old name) - Add `#[tokio::main]` and `async fn main` to README example since Entry methods are async, and mark it `no_run` since it needs a real keyring backend - Add `.await` to `set_password()` calls in mock.rs doctest and wrap in a tokio runtime block Fixes astral-sh#18916 https://claude.ai/code/session_01UJXU3iFvu9dLce56ZvNNDu
This is an internal vendored crate — the doctests duplicate coverage already provided by unit tests and would break again on any upstream sync. Mark the code blocks as `ignore` so they remain as documentation but don't run. Also remove the `doc-comment` dev-dependency and README doctest inclusion since the README example is now ignored too. https://claude.ai/code/session_01UJXU3iFvu9dLce56ZvNNDu
The mock.rs code blocks duplicated unit test coverage and were prone to drifting from reality on upstream syncs — remove them entirely, keeping the prose. The README code block doesn't need `ignore` since the `doc_comment::doctest!` inclusion was already removed. https://claude.ai/code/session_01UJXU3iFvu9dLce56ZvNNDu
auto-merge was automatically disabled
April 8, 2026 13:50
Head branch was pushed to by a user without write access
77ae070 to
0e3e9c5
Compare
Contributor
|
This seems to work for me as a downstream patch. Thanks! |
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.
Closes #18916