mongoose-query-paginate icon indicating copy to clipboard operation
mongoose-query-paginate copied to clipboard

wish: documentation

Open markstos opened this issue 8 years ago • 0 comments

The example provided in the README is helpful, but some written documentation would still be helpful, for example, to document that loading this module modifies the global Mongoose Query object as a side-effect.

It can be important that developers load the module with a bare require and not like this:

paginate       = require('mongoose-query-paginate'),

If a syntax like that is used, a code linter may pick it as an error about an "unused variable" which may in turn cause under team member to use it.

Basic documentation is generally good, but that's a specific example of it could help in this case.

markstos avatar Sep 29 '17 17:09 markstos