feat: random_str/src/lib.rs now includes content of its README.md - good for docs.rs#4
Open
peter-lyons-kehl wants to merge 1 commit into
Open
Conversation
Contributor
Author
Owner
|
Thanks again. I'm fine with your suggestions, feel free to remove one readme, creating the symlinks and adding the triple licensing. |
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.

Now rustdoc, docs.rs (and probably rust-analyzer-generated docs in IDE mouseovers/tool tips) include and render content README.md.
Side note 1: I see two README.md files. Suggest having just one, and using a symlink from the other location. That may not completely work for developers on Windows, but they can workaround.
Side note 2: both README.md files link to LICENSE, which doesn't exist. EDIT: That's because I made
random_str/random_str/src/lib.rsinclude../README.md, which is the copy underrandom_str/random_strand not under the rootrandom_str/. Suggest adding a symlink for LICENSE - I'm happy to add that to this pull request.Side note 3: Suggest considering dual licensing under Apache-2.0 OR MIT, as is common in Rust ecosystem. (
randdoes that, too.) Or even triple licensing under Apache-2.0, MIT and BSD (my prudent-rs/prudent or its sister crate (about to be born/named) is going to depend onrandom_str, and I triple license). For that you could uselicense = "BSD-2-Clause OR Apache-2.0 OR MIT".