Static "Q.when()" mentioned but not formally documented.

kriskowal / q

A promise library for JavaScript

MIT License

14.95k stars 1.2k forks source link

Static "Q.when()" mentioned but not formally documented. #807

Open i-am-al-x opened 7 years ago

i-am-al-x commented 7 years ago

The very first paragraph of the API documentation has the following:

For example, Q.when(5, onFulfilled) is equivalent to Q(5).then(onFulfilled).

This is the only mention of "Q.when()". Since the capability is available for use, it should have formal mention within the itemized listing of methods, and so also a formal definition.

kriskowal commented 7 years ago

A PR would be welcome.