Apply best practices to cargo.toml#230
Open
koenw wants to merge 1 commit into
Open
Conversation
* Point the `homepage` field to the actual homepage The [`cargo.toml` manifest documentation](https://doc.rust-lang.org/cargo/reference/manifest.html) explicitly mentions the `homepage` field should not be redundant with the `documentation` or `repository` values and should instead only be used if a dedicated homepage for the project exists. Additionally, since users already have a link to the source code (from the `repository` field) we can be more useful to users by linking them to the actual homepage. * Point the `documentation` field to the documentation page on the website Similarly the `documentation` field should be pointing to a website hosting the project's documentation.
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
1 participant
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.
Point the
homepagefield to the actual homepage Thecargo.tomlmanifest documentation explicitly mentions thehomepagefield should not be redundant with thedocumentationorrepositoryvalues and should instead only be used if a dedicated homepage for the project exists.Additionally, since users already have a link to the source code (from the
repositoryfield) we can be more useful to users by linking them to the actual homepage.Point the
documentationfield to the documentation page on the website Similarly thedocumentationfield should be pointing to a website hosting the project's documentation.