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

More documentation #4

Merged
merged 3 commits into from
Jan 24, 2016
Merged

More documentation #4

merged 3 commits into from
Jan 24, 2016

Conversation

frewsxcv
Copy link
Contributor

Rebase of #3 to work with stable and beta. I couldn't get cfg_attr!() to work correctly with conditionally turning on features, so I just disabled the nightly-only tests for now.

Fixes #3.

Review on Reviewable

- Change the description from something rustc-specific to something
  more general, outlining its advantages and disadvantages (and
  linking to graphs)
- Move the important parts to the crate doc instead of the struct's
  doc, which makes it easier to find
- Add inline Rustdoc examples for using it with HashMap and HashSet
- Put the test in a module (not important, but it's what people
  expect to see)
@frewsxcv
Copy link
Contributor Author

r? @SimonSapin

@SimonSapin
Copy link
Member

r=me the version number bumped to 1.0.1 to publish on crates.io, where Servo can pick it up in order to have the docs show up on doc.servo.org.

@frewsxcv
Copy link
Contributor Author

@bors-servo r=SimonSapin

@frewsxcv
Copy link
Contributor Author

@SimonSapin

  1. it appears homu is not setup to manage this repo (Add rust-fnv to homu saltfs#201)
  2. it appears servo org members do not have write access to this repo, so i don't see the green merge button

@jdm
Copy link
Member

jdm commented Jan 23, 2016

I fixed the repo collaborators to address point 2.


```toml
[dependencies]
fnv = "1.0.0"

Choose a reason for hiding this comment

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

This should be bumped to 1.0.1

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't see any reason to bump this everytime we release a new 1.0.x release

SimonSapin added a commit that referenced this pull request Jan 24, 2016
@SimonSapin SimonSapin merged commit 62f062b into servo:master Jan 24, 2016
@SimonSapin SimonSapin deleted the docs branch January 24, 2016 01:48
@SimonSapin
Copy link
Member

Thanks @frewsxcv and @ogham !

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.

5 participants