-
-
Notifications
You must be signed in to change notification settings - Fork 11
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
Documentation is missing a bunch of functionality? #66
Comments
Hi @Jakobud! The auto generated documentation is missing some information that does exist in the README. Thus, it is better to check the README file for the time being. For The documentation generated for |
Hi... Very useful looking library... Just a tip here re: the JSDoc... The proper JSDoc per the second example at https://jsdoc.app/tags-param.html#parameters-with-properties is that you should add /**
* @constructor
* @param {Object} options A set op options to pass to the throttle function
* @param {number} options.requestsPerSecond The amount of requests per
* second the library will limit to
*/ This might cause your documentation generator to give the intended result. |
Perhaps I'm missing something, but it seems like your examples use a lot of functionality that is missing from your documentation. For example I don't see anything in the docs about
createPromiseThrottle
,promiseImplementation
option, etc. Also your documentation describesrequestsPerSecond
as a function argument, not an option but your examples show the opposite.Just confused here maybe...
The text was updated successfully, but these errors were encountered: