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

New Documentation in README.md #1

Merged
merged 4 commits into from Aug 10, 2011
Merged

New Documentation in README.md #1

merged 4 commits into from Aug 10, 2011

Conversation

odie5533
Copy link

I added a bit of documentation to README.md which should help complement the examples.

@chjj
Copy link
Owner

chjj commented Aug 10, 2011

Ah, I've been meaning to clean up the readme. A few small things though, it's probably important to clarify that db.kill kills the entire db. It will delete the db file and create a new one instead of merely closing it.

Also, the deep parameter specifies whether an object will contain only cached properties, (or maybe values is a better term). It doesn't refer to the objects themselves.

@odie5533
Copy link
Author

I changed the description for kill(), but I still don't understand what effect changing deep will have on the returns documents.

@chjj chjj merged commit bdfcf08 into chjj:master Aug 10, 2011
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.

None yet

2 participants