doc: Clarify msg when doc/api/cli.md not updated - #10872
Closed
sxa wants to merge 1 commit into
Closed
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
Maybe worth including either a link to the docs or the command to run, i.e. one of: perl -pi -e "s/REPLACEME/$VERSION/g" doc/api/*.md
sed -i "s/REPLACEME/$VERSION/g" doc/api/*.mdAlso Clarify->clarify in the commit message
Otherwise LGTM |
Sorry, something went wrong.
Copy link
Copy Markdown
Member
Author
|
Yeah can do - it's just a bit more difficult to write the message in 80 characters and include all the references. I've changed it from: Please update Added: tags in the documentation (REPLACEME in doc/api/*.md) first. to Please update REPLACEME in Added: tags in doc/api/*.md (See doc/releases.md) |
Sorry, something went wrong.
gibfahn
approved these changes
Jan 18, 2017
italoacasas
approved these changes
Feb 2, 2017
TimothyGu
approved these changes
Feb 2, 2017
TimothyGu
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
LGTM with a nit.
Sorry, something went wrong.
Comment thread
Makefile
| @if [ "$(DISTTYPE)" != "nightly" ] && [ "$(DISTTYPE)" != "next-nightly" ] && \ | ||
| `grep -q REPLACEME doc/api/*.md`; then \ | ||
| echo 'Please update Added: tags in the documentation first.' ; \ | ||
| echo 'Please update REPLACEME in Added: tags in doc/api/*.md (See doc/releases.md)' ; \ |
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
s/See/see/
Sorry, something went wrong.
jasnell
approved these changes
Feb 2, 2017
Copy link
Copy Markdown
|
CI: https://ci.nodejs.org/job/node-test-pull-request/6182/console btw we need CI when the change is on the makefile? |
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
@italoacasas Not sure we really need CI, but we might as well run it anyway. |
Sorry, something went wrong.
jasnell
pushed a commit
that referenced
this pull request
Feb 3, 2017
PR-URL: #10872 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
italoacasas
pushed a commit
that referenced
this pull request
Feb 4, 2017
PR-URL: #10872 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
italoacasas
pushed a commit
to italoacasas/node
that referenced
this pull request
Feb 14, 2017
PR-URL: nodejs#10872 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
krydos
pushed a commit
to krydos/node
that referenced
this pull request
Feb 25, 2017
PR-URL: nodejs#10872 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
jasnell
pushed a commit
that referenced
this pull request
Mar 7, 2017
PR-URL: #10872 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
jasnell
pushed a commit
that referenced
this pull request
Mar 7, 2017
PR-URL: #10872 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 9, 2017
PR-URL: #10872 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
Mar 9, 2017
PR-URL: #10872 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Italo A. Casas <me@italoacasas.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
6 participants
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.
Checklist
Affected core subsystem(s)
build
The message printed out when the doc/api/cli.md file had not had the REPLACEME tags replaced could do with being made clearer. This PR updates it to indicate which the top level Makefile is checking for.
Cc: @bnoordhuis who put in the original message.