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

Document expected performance #194

Open
xaviershay opened this issue Aug 16, 2015 · 0 comments
Open

Document expected performance #194

xaviershay opened this issue Aug 16, 2015 · 0 comments

Comments

@xaviershay
Copy link
Contributor

Forking from #134.

Given we are making performance claims ("At the same time, they remain CPU and memory-efficient by sharing between copies.") we should include expected operation cost in the YARD docs (O(1), O(n), etc).

At the same time, proving an "implementation details" section for each collection type would be useful to future committers. Something like "Hash is implemented using a persistent Trie, as outlined in . It provides the following performance guarantees: ..."

If anyone was able to brain dump details into this issue, I'm happy to clean them up and amend docs.

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

1 participant