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

docs: Adds usage of readline line-by-line parsing #4609

Closed
wants to merge 2 commits into from
Closed

docs: Adds usage of readline line-by-line parsing #4609

wants to merge 2 commits into from

Conversation

eljefedelrodeodeljefe
Copy link
Contributor

In order to make developers aware of node-core built-in
functionality, which might replace module APIs, we should
add an example of readline`s interface usage.
SEO will eventually aid this goal, since it is well searched
on Q&A sites.

PR-URL: #4609
Reviewed-By:

@mscdex mscdex added doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module. labels Jan 10, 2016
@mscdex
Copy link
Contributor

mscdex commented Jan 10, 2016

I think it may be better to include the new example after the one at the top of the document.

In order to make developers aware of node-core built-in
functionality, which might replace module APIs, we should
add an example of readline`s interface usage.
SEO will eventually aid this goal, since it is well searched
on Q&A sites.

PR-URL: #4609
Reviewed-By:
@eljefedelrodeodeljefe
Copy link
Contributor Author

Okay, thanks. Did this in 89b2254. I force pushed the commit, but apparently it didn't update in the PR. Won't do this again...

@eljefedelrodeodeljefe
Copy link
Contributor Author

@silverwind I agree. Wasn't sure there. Did this in 228dd24. Thanks.

@silverwind
Copy link
Contributor

LGTM

@ryansobol
Copy link
Contributor

LGTM, although you might want to squash the commits down to just one.

@silverwind
Copy link
Contributor

Squashing is not an issue, we do that when landing. I acutally prefer them unsquashed so one can track changes that happens during the PRs lifetime.

@eljefedelrodeodeljefe
Copy link
Contributor Author

Okay. Looking at the process, I'd prefer it unsquashed also, in general. However you want it...

@ryansobol
Copy link
Contributor

Makes sense. :)

@jasnell
Copy link
Member

jasnell commented Jan 11, 2016

LGTM

silverwind pushed a commit that referenced this pull request Jan 11, 2016
In order to make developers aware of node-core built-in
functionality, which might replace module APIs, we should
add an example of readline`s interface usage.
SEO will eventually aid this goal, since it is well searched
on Q&A sites.

PR-URL: #4609
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>>
@silverwind
Copy link
Contributor

Thanks! Landed in 5a53cba.

@silverwind silverwind closed this Jan 11, 2016
@eljefedelrodeodeljefe
Copy link
Contributor Author

Cool. Thanks @silverwind . Will delete the branch then.

@eljefedelrodeodeljefe eljefedelrodeodeljefe deleted the docs/example-readline-line-by-line branch January 11, 2016 19:40
MylesBorins pushed a commit that referenced this pull request Jan 11, 2016
In order to make developers aware of node-core built-in
functionality, which might replace module APIs, we should
add an example of readline`s interface usage.
SEO will eventually aid this goal, since it is well searched
on Q&A sites.

PR-URL: #4609
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>>
@MylesBorins MylesBorins mentioned this pull request Jan 11, 2016
MylesBorins pushed a commit that referenced this pull request Jan 12, 2016
In order to make developers aware of node-core built-in
functionality, which might replace module APIs, we should
add an example of readline`s interface usage.
SEO will eventually aid this goal, since it is well searched
on Q&A sites.

PR-URL: #4609
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>>
MylesBorins pushed a commit that referenced this pull request Jan 13, 2016
In order to make developers aware of node-core built-in
functionality, which might replace module APIs, we should
add an example of readline`s interface usage.
SEO will eventually aid this goal, since it is well searched
on Q&A sites.

PR-URL: #4609
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>>
MylesBorins pushed a commit that referenced this pull request Jan 14, 2016
In order to make developers aware of node-core built-in
functionality, which might replace module APIs, we should
add an example of readline`s interface usage.
SEO will eventually aid this goal, since it is well searched
on Q&A sites.

PR-URL: #4609
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>>
MylesBorins pushed a commit that referenced this pull request Jan 14, 2016
In order to make developers aware of node-core built-in
functionality, which might replace module APIs, we should
add an example of readline`s interface usage.
SEO will eventually aid this goal, since it is well searched
on Q&A sites.

PR-URL: #4609
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>>
@rvagg
Copy link
Member

rvagg commented Jan 18, 2016

I think this is your first commit to core @eljefedelrodeodeljefe, welcome on board! It looks like you're already getting comfortable in the docs, we appreciate it and hope you're able to grok the processes and preferences around here, let us know if you need help on that front.

MylesBorins pushed a commit that referenced this pull request Jan 19, 2016
In order to make developers aware of node-core built-in
functionality, which might replace module APIs, we should
add an example of readline`s interface usage.
SEO will eventually aid this goal, since it is well searched
on Q&A sites.

PR-URL: #4609
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>>
@MylesBorins MylesBorins mentioned this pull request Jan 19, 2016
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
In order to make developers aware of node-core built-in
functionality, which might replace module APIs, we should
add an example of readline`s interface usage.
SEO will eventually aid this goal, since it is well searched
on Q&A sites.

PR-URL: nodejs#4609
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>>
@matthiasg
Copy link

It would have been great had this new documentation also included information on how to process each line asynchronously

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. readline Issues and PRs related to the built-in readline module.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants