Repository navigation
docs(inspect-presidio): a crate README, and make every crate publishable - #101
Merged
Merged
Conversation
The new crate shipped without the things a reader looks for first. pasu-pii-kr has a README, keywords, categories and a readme field; this had a bare description and nothing else, so on crates.io it would have been a name and one line. The README says what crosses, what does not and why — the four things that do not survive a Presidio import are the crate's actual subject, and burying them in rustdoc leaves them where nobody deciding whether to use it will look. Its usage example is a doctest rather than a code fence, so the compiler owns it. A README example that has drifted from the API is worse than none: it is confidently wrong, and it is the first thing anyone runs. Separately, no crate here could be published at all. Every pasu-to-pasu dependency was path-only, and cargo refuses to publish a crate whose dependency carries no version — so the crates.io step would have failed on the first attempt, for all of them, for a reason that has nothing to do with the code. Versions are aligned at 0.2.0 across the workspace, so each path dependency now carries one. Verified with cargo package on both ends of the graph. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Two things a reader looks for first, missing.
The crate README
pasu-pii-krhas a README, keywords, categories and areadmefield. The new crate had a bare description, so on crates.io it would have been a name and one line.The README leads with what crosses, what does not, and why — the four things that do not survive a Presidio import are the crate's actual subject, and leaving them in rustdoc puts them where nobody deciding whether to use it will look.
Its usage example is a doctest, not a code fence, so the compiler owns it. A README example that has drifted from the API is worse than none: it is confidently wrong, and it is the first thing anyone runs.
No crate here could be published
Every pasu-to-pasu dependency was path-only:
cargo refuses to publish a crate whose dependency carries no version, so the crates.io step would have failed on the first attempt — for all of them, for a reason unrelated to the code.
Versions are aligned at
0.2.0across the workspace, so each path dependency now carries one. Verified withcargo packageon both ends of the graph:Nine files touched, all mechanical.
🤖 Generated with Claude Code