Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve 'frunk', 'frunk_core', and 'frunk_derives' package metadata. #43

Merged
merged 4 commits into from
Mar 16, 2017

Conversation

jswrenn
Copy link
Contributor

@jswrenn jswrenn commented Mar 16, 2017

Added documentation key to rendering of documentation for latest published version of each crate. Renamed homepage key to repository. Added badges table and travis-ci item.

Added `documentation` key to rendering of documentation for latest published version of this crate. Renamed `homepage` key to `repository`. Added `badges` table and `travis-ci` item.
Copy link
Owner

@lloydmeta lloydmeta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! I didn't know about these keys, so thanks for adding them.

I've left a couple of comments / nitpicks that aren't blockers.

Cargo.toml Outdated
@@ -4,9 +4,13 @@ version = "0.1.19"
authors = ["Lloyd <lloydmeta@gmail.com>"]
description = "Frunk provides developers with a number of functional programming tools like HList, Generic, LabelledGeneric, Validated, Monoid, Semigroup and friends."
license = "MIT"
homepage = "https://github.com/lloydmeta/frunk"
documentation = "https://docs.rs/frunk/0.1.19/frunk/"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like we can leave off the part of the path that deals with versioning (e.g. https://docs.rs/frunk) so that we can always just look at the latest published version. A bit less to maintain :)

core/Cargo.toml Outdated
documentation = "https://docs.rs/frunk_core/0.0.9/frunk_core/"
repository = "https://github.com/lloydmeta/frunk"
keywords = [ "HList", "Generic"]
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be nice to add LabelledGeneric to this as well.

core/Cargo.toml Outdated
documentation = "https://docs.rs/frunk_core/0.0.9/frunk_core/"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docs.rs/frunk_core should be fine I think.

@@ -4,9 +4,13 @@ version = "0.0.10"
authors = ["Lloyd <lloydmeta@gmail.com>"]
description = "frunk_derives contains the custom derivations for certain traits in Frunk."
license = "MIT"
homepage = "https://github.com/lloydmeta/frunk"
documentation = "https://docs.rs/frunk_derives/0.0.10/frunk_derives/"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://docs.rs/frunk_derives will look up the latest published version.

@@ -4,9 +4,13 @@ version = "0.0.10"
authors = ["Lloyd <lloydmeta@gmail.com>"]
description = "frunk_derives contains the custom derivations for certain traits in Frunk."
license = "MIT"
homepage = "https://github.com/lloydmeta/frunk"
documentation = "https://docs.rs/frunk_derives/0.0.10/frunk_derives/"
repository = "https://github.com/lloydmeta/frunk"
keywords = [ "HList", "Generic", "derives"]
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know you didn't touch this, but maybe we can either delete Hlist and Generic from here or get rid of keywords altogether.

Removed "HList" and generic "Generic" from frunk_derives manifest. Added "Frunk" as a keyword to each package, following the convention of serde.
@lloydmeta
Copy link
Owner

Perfect this looks great. Thanks again !

@lloydmeta lloydmeta merged commit d2d6bbb into lloydmeta:master Mar 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants