Add readmes to all implementation crates specifying that they do no offer stable interfaces #2320
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
mamcx
added
documentation
mamcx
changed the title
Centril
reviewed
Feb 28, 2025
gefjon
approved these changes
Feb 28, 2025
Contributor
gefjon
left a comment
gefjon
left a comment
There was a problem hiding this comment.
Discussions with Mazdak should be resolved, but this all looks ok to me. We can always add docs and stability guarantees to these crates later, as it becomes useful.
mamcx
force-pushed
the
mamcx/readme-no-stable
branch
from
082712e to
d07995b
Compare
mamcx
force-pushed
the
mamcx/readme-no-stable
branch
from
b6c4b6e to
d9359db
Compare
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.
Description of Changes
Closes private #1156.
Notes to reviewer:
Binaries are not documented, so I don't put the readme there
It could be desirable to use
doc = false, but it need judgments here, like it could be nice to see whatsatsare or see at the internal documentation of thecore.I not decided if should add the same note to the
lib.rsso is visible indocs.rs. Should I?Readme's with**Internal Crate**are distinct from**Unstable Crate**for what I think the later is useful for the public to see and know, but is still in flux.API and ABI breaking changes
It could change what is seen in
crates.rs/docs/rs, that is intentional.Expected complexity level and risk
1
Testing
cargo +nightly publish -Z package-workspace --allow-dirty --dry-run --workspace --exclude ..., but it failed in weird ways, so this depends on manual inspection.