move documentation from README.md to lib.rs #921
Merged
Conversation
This file contains 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
so it appears on https://docs.rs and inconsistencies aren't created between README.md and lib.rs per discussion in rust-lang#920 The old introductory text in lib.rs has been replaced with the text from README.md and the introductory paragraph revised. Otherwise no major changes to the text have been made.
NobodyXu
approved these changes
Jan 29, 2024
|
cc @thomcc I would like your review on this PR |
|
I will merge this before next release to minimize the disruption. |
Merged
|
potentially both could be kept by using the doc = include_str! trick. I think |
|
The trouble with |
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.
so it appears on https://docs.rs and inconsistencies aren't created between README.md and lib.rs
per discussion in #920
The old introductory text in lib.rs has been replaced with the text from README.md and the introductory paragraph revised. Otherwise no major changes to the text have been made.
I will follow this PR with more substantial edits to the text.