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

Documentation for how to unref readline #36458

Closed
wants to merge 3 commits into from

Conversation

vbinithyanandamv
Copy link

#36154

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module. labels Dec 9, 2020
Removed tab character and added 2 space
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing this. One minor nit:

doc/api/readline.md Outdated Show resolved Hide resolved
As per suggestion.

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
@vbinithyanandamv
Copy link
Author

Thanks for doing this. One minor nit:

@aduh95 updated.

@aduh95
Copy link
Contributor

aduh95 commented Dec 30, 2020

Reading through the readline docs, it seems this example may be lacking context. Could you add a sentence explaining the use-case and when it is useful?

@Trott
Copy link
Member

Trott commented Jan 9, 2021

Welcome, @vbinithyanandamv and thanks for the pull request. I'm not sure this warrants its own section. Seems like it should go in the section of whatever call might result in requiring the unref() call. It would be good to incorporate it into an existing section, I think.

@aduh95
Copy link
Contributor

aduh95 commented Feb 19, 2021

@vbinithyanandamv Are you still planing on working on this?

@vbinithyanandamv
Copy link
Author

@vbinithyanandamv Are you still planing on working on this?

@vbinithyanandamv not any soon, you can take it up if you want to work on it.

@aduh95 aduh95 added help wanted Issues that need assistance from volunteers or PRs that need help to proceed. stalled Issues and PRs that are stalled. labels Feb 19, 2021
@github-actions
Copy link
Contributor

This issue/PR was marked as stalled, it will be automatically closed in 30 days. If it should remain open, please leave a comment explaining why it should remain open.

@github-actions
Copy link
Contributor

Closing this because it has stalled. Feel free to reopen if this PR is still relevant, or to ping the collaborator who labelled it stalled if you have any questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. help wanted Issues that need assistance from volunteers or PRs that need help to proceed. readline Issues and PRs related to the built-in readline module. stalled Issues and PRs that are stalled.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants