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

Expand crate-level documentation #32

Open
Tracked by #38
sfackler opened this issue May 7, 2017 · 3 comments
Open
Tracked by #38

Expand crate-level documentation #32

sfackler opened this issue May 7, 2017 · 3 comments

Comments

@sfackler
Copy link
Contributor

sfackler commented May 7, 2017

The root of a crate's documentation is the first thing a prospective user sees, and should provide an introduction to both the concepts the library deals with as well as quick examples of common usage patterns. See https://github.com/jonathandturner/rfcs/blob/b4ff67a2406651372c72fe7af856c3af62846e67/text/0000-api-doc-frontpage-styleguide.md for the kinds of things the crate root docs should discuss.

@sfackler
Copy link
Contributor Author

sfackler commented May 7, 2017

Note that this should be sequenced after #33.

Particular care should be taken to discuss what exactly the safety considerations are around the unsafe constructors.

@burdges
Copy link

burdges commented Jun 10, 2017

Are there any nice to read examples or discussions of people using memmap to back large tables? Ideally in Rust using this crate, but even in C if needs be. I want to get an idea for what I don't know about using memmap before using it.

@danburkert
Copy link
Owner

@burdges what do you mean by a table? To get a good sense of what people are using the crate for I'd recommend looking at https://crates.io/crates/memmap/reverse_dependencies. fst and sanakirja might be particularly interesting if you are looking to use mmap for file reading/writing.

@brson brson mentioned this issue Jul 6, 2017
3 tasks
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

No branches or pull requests

3 participants