Improve documentation

Question

delvedor opened this issue 7 years ago · 5 comments

At the moment the documentation is almost complex as the actual code, we should fix that.

Answer 1 · 2018-04-18T20:05:32.000Z

Also for the app.use(func, [opts]):
Loads one or more functions asynchronously. The function must have the signature: instance, options, done

Is it an inconsistency or misunderstanding on my part that the asynchronous function does not respect the signature?

async function plugin (server, opts) {} // without done

PS: This is to help me in writing Typescript definitions ^^

Answer 2 · 2018-04-18T20:20:06.000Z

As said the docs can be improved. There is no need for done with async functions.

Answer 3 · 2022-09-01T05:11:04.000Z

The documentation definitely needs a complete overhaul.

Answer 4 · 2022-09-01T08:40:47.000Z

Would you like to help?

Answer 5 · 2022-09-01T09:53:55.000Z

Would you like to help?

I prefer to help with something I know very well, so it's rather No.