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.

Sign up for GitHub

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

Jump to bottom

Add Clarity to Documentation #3

Open
jonfairbanks opened this issue Dec 6, 2016 · 0 comments
Open

Add Clarity to Documentation #3

jonfairbanks opened this issue Dec 6, 2016 · 0 comments

Comments

@jonfairbanks
Copy link

jonfairbanks commented Dec 6, 2016 •
edited
Loading

This module could benefit from better documentation and examples, particularly this line:
var empseq = mongoSequence(db,'employees');

What are the requirements for db? When using my pre-existing db connector, the module throws errors. Is employees a database name or field name here?

Additionally, getNext is barely mentioned in the Readme, but is central to the module.
@jonfairbanks jonfairbanks changed the title Docs Add Clarity to Documentation Dec 6, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jonfairbanks