GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc: Stream 'finish' event string interpolation fix by vhmth · Pull Request #12221 · nodejs/node

Conversation

@vhmth

@vhmth vhmth commented Apr 4, 2017

Copy link
Copy Markdown
Contributor
Checklist
  • [x ] documentation is changed or added
  • [x ] commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

String interpolation in the docs in the Stream 'finish' event example does not use back ticks `.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to Node.js documentation. stream Issues and PRs related to Node.js streams. labels Apr 4, 2017
@aqrln

aqrln commented Apr 4, 2017 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

Good catch and thanks for the contribution! Can you please format your commit message according to the commit guidelines? The first word after the subsystem must start with a lowercase letter (and should be an imperative verb) and the whole line must not exceed 50 characters.

vsemozhetbyt reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

vsemozhetbyt
vsemozhetbyt approved these changes Apr 4, 2017
View reviewed changes

@vsemozhetbyt vsemozhetbyt left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM with the mentioned nits concerning commit message.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@vhmth
doc: fix string interpolation in Stream 'finish'
a143a81
@vhmth

vhmth commented Apr 4, 2017

Copy link
Copy Markdown
Contributor Author

Done! Should fit in 50 chars now too

vsemozhetbyt reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@aqrln

aqrln commented Apr 4, 2017

Copy link
Copy Markdown
Contributor

@vhmth great!

@vsemozhetbyt IMO, the change is trivial enough to not wait for 48 hours to land. What do you think?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vsemozhetbyt

vsemozhetbyt commented Apr 4, 2017 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

@aqrln I am still a bit uncertain about timeframe in these cases. @nodejs/documentation, how quick can such fixes be landed?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@jasnell

jasnell commented Apr 4, 2017

Copy link
Copy Markdown
Member

The minimum time for most PRs is 48 hours, 72 hours over the weekend. We can shorten the time for very trivial doc changes but those are rare.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

jasnell
jasnell approved these changes Apr 4, 2017
View reviewed changes
@vhmth

vhmth commented Apr 4, 2017

Copy link
Copy Markdown
Contributor Author

Don't worry guys we have all the time in the world once singularity hits. 🤖

aqrln and vsemozhetbyt reacted with laugh emoji
All reactions
  • 😄 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vsemozhetbyt

vsemozhetbyt commented Apr 4, 2017

Copy link
Copy Markdown
Contributor

@jasnell Is this trivial? If so, how much can the time be shorten?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

Trott
Trott approved these changes Apr 4, 2017
View reviewed changes

@Trott Trott left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@Trott

Trott commented Apr 4, 2017

Copy link
Copy Markdown
Member

There's no hard-and-fast rules on what is "trivial" and how much things can be shortened. Use your judgment. (And if your judgment is way off, someone will tell you. The CTC can always revise the rules if there's an epidemic of PRs landing too quickly.)

In my opinion, this is definitely trivial enough that you can land it right now. (I generally try to get at least two other people to say "yeah, land this right away", if that helps.) It's a tiny doc change that is easy and harmless to undo if it turns out there's something wrong with it that we're all missing.

vsemozhetbyt and gibfahn reacted with thumbs up emoji
All reactions
  • 👍 2 reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@Trott

Trott commented Apr 4, 2017

Copy link
Copy Markdown
Member

(All that said: If in doubt, just wait the 48 hours. There's no huge benefit to trivial docs landing faster other than it keeping them out of our backlog and not frustrating contributors who just want to add a missing apostrophe in a doc or something like that.)

vsemozhetbyt reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vhmth

vhmth commented Apr 4, 2017

Copy link
Copy Markdown
Contributor Author

Are y'all able to set up a system where PRs get auto-merged at the 48hr mark with a certain amount of approvals?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@jasnell

jasnell commented Apr 4, 2017

Copy link
Copy Markdown
Member

@vhmth ... auto-merging generally is not a great approach. In addition to the 48 hours, most PRs require one or more CI runs, may need additional testing using our "Canary in the Gold Mine" (CITGM) tool, or otherwise just need another set of eyes to sanity check things. There are also a number of requirements we have for squashing and formatting commit messages that we could automate but there's little apparent benefit in doing so.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@jasnell

jasnell commented Apr 4, 2017

Copy link
Copy Markdown
Member

btw, +1 to this being trivial enough to land whenever you're ready.

vsemozhetbyt reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

vsemozhetbyt pushed a commit that referenced this pull request Apr 4, 2017
@vhmth @vsemozhetbyt
doc: fix string interpolation in Stream 'finish'
82ef00c
PR-URL: #12221
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@vsemozhetbyt

vsemozhetbyt commented Apr 4, 2017

Copy link
Copy Markdown
Contributor

Landed in 82ef00c

Thank you, @vhmth !

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@vsemozhetbyt vsemozhetbyt closed this Apr 4, 2017
@vhmth

vhmth commented Apr 4, 2017

Copy link
Copy Markdown
Contributor Author

Boom!

vsemozhetbyt reacted with hooray emoji
All reactions
  • 🎉 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

italoacasas pushed a commit to italoacasas/node that referenced this pull request Apr 10, 2017
@vhmth Italo A. Casas
doc: fix string interpolation in Stream 'finish'
74d0266
PR-URL: nodejs#12221
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@italoacasas italoacasas mentioned this pull request Apr 10, 2017
v7.9.0 Release Proposal #12319
Merged
2 tasks done
@vsemozhetbyt vsemozhetbyt mentioned this pull request Apr 17, 2017
add missing ) in CONTRIBUTING.md #12444
Closed
2 tasks done
@MylesBorins MylesBorins added the land-on-v6.x label Apr 18, 2017
MylesBorins pushed a commit that referenced this pull request Apr 18, 2017
@vhmth @MylesBorins
doc: fix string interpolation in Stream 'finish'
e9a6ddd
PR-URL: #12221
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
MylesBorins pushed a commit that referenced this pull request Apr 19, 2017
@vhmth @MylesBorins
doc: fix string interpolation in Stream 'finish'
c0d9b1c
PR-URL: #12221
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Apr 19, 2017
v6.10.3 proposal #12498
Merged
andrew749 pushed a commit to michielbaird/node that referenced this pull request Jul 19, 2017
@vhmth @andrew749
doc: fix string interpolation in Stream 'finish'
dd80a33
PR-URL: nodejs/node#12221
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnell jasnell jasnell approved these changes
@Trott Trott Trott approved these changes
+1 more reviewer
@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

doc Issues and PRs related to Node.js documentation. stream Issues and PRs related to Node.js streams.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

7 participants

@vhmth @aqrln @vsemozhetbyt @jasnell @Trott @MylesBorins @nodejs-github-bot
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.