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

Improve documentation #24

Open
delvedor opened this issue Sep 18, 2017 · 5 comments
Open

Improve documentation #24

delvedor opened this issue Sep 18, 2017 · 5 comments
Labels
good first issue Good for newcomers

Comments

@delvedor
Copy link
Member

At the moment the documentation is almost complex as the actual code, we should fix that.
marcbachmann added a commit to marcbachmann/avvio that referenced this issue Nov 10, 2017
@marcbachmann
Replace legacy boot variable with the app avvioo instance
5d92059 
The `boot` variable was still in use since the module got renamed and caused confusion for some people.
This change makes the documentation a bit more readable.

There's still fastify#24 to tackle.
@marcbachmann marcbachmann mentioned this issue Nov 10, 2017
Merged
@poupryc
Copy link
Contributor

poupryc commented Apr 18, 2018 •
edited
Loading

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 ^^

@mcollina
Copy link
Member

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

@minemax-ua
Copy link

The documentation definitely needs a complete overhaul.

@mcollina
Copy link
Member

mcollina commented Sep 1, 2022

Would you like to help?

@minemax-ua
Copy link

Would you like to help?

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

@Eomm Eomm added the good first issue Good for newcomers label Sep 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@mcollina @minemax-ua @delvedor @Eomm @poupryc