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.

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

Is documentation up to date? #269

Closed
Nargonath opened this issue Aug 2, 2017 · 4 comments
Closed

Is documentation up to date? #269

Nargonath opened this issue Aug 2, 2017 · 4 comments

Comments

@Nargonath
Copy link
Contributor

The documentation like 'Quick Start' seems to be off. It mentions the close event but it doesn't appear in the API documentation not it has been triggered in my app.

I'll be happy to make a PR to update the doc but I just wanted to make sure of it.

By the way I used the event end instead.

@soyuka
Copy link
Contributor

soyuka commented Aug 2, 2017

Yes use the end event instead. close might not be present when there is no file descriptor involved #252 (comment)

Feel free to send a patch to update the documentation!

@Nargonath
Copy link
Contributor Author

Alright thank you, I'll send a PR when possible (I'm on vacation soon).

@ctalkington
Copy link
Member

i think we can add a note somewhere in the docs; feel free to suggest via PR or once i work through a few remaining tasks for the next release, Ill try to work something in

@Nargonath
Copy link
Contributor Author

Thanks for your answer. I haven't been able to work on it so far. Got soaked up by work and personal after the vacations. If I haven't done anything by the time you are available to make it, feel free to add that note. Thanks for your time again. 👍

Nargonath added a commit to Nargonath/node-archiver that referenced this issue Oct 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants