doc: Clarify msg when doc/api/cli.md not updated #10872

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
6 participants
@sxa555
Contributor

sxa555 commented Jan 18, 2017

Checklist
  • commit message follows commit guidelines
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.

@gibfahn

This comment has been minimized.

Show comment
Hide comment
@gibfahn

gibfahn Jan 18, 2017

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/*.md

Also Clarify->clarify in the commit message

doc: Clarify msg when doc/api/cli.md not updated

Otherwise LGTM

Member

gibfahn commented Jan 18, 2017

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/*.md

Also Clarify->clarify in the commit message

doc: Clarify msg when doc/api/cli.md not updated

Otherwise LGTM

@sxa555

This comment has been minimized.

Show comment
Hide comment
@sxa555

sxa555 Jan 18, 2017

Contributor

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)

Contributor

sxa555 commented Jan 18, 2017

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)

@TimothyGu

LGTM with a nit.

@@ -498,7 +498,7 @@ PKGDIR=out/dist-osx
release-only:
@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)' ; \

This comment has been minimized.

@TimothyGu

TimothyGu Feb 2, 2017

Member

s/See/see/

@TimothyGu

TimothyGu Feb 2, 2017

Member

s/See/see/

@jasnell

jasnell approved these changes Feb 2, 2017

@italoacasas

This comment has been minimized.

Show comment
Hide comment
@italoacasas

italoacasas Feb 3, 2017

Member

CI: https://ci.nodejs.org/job/node-test-pull-request/6182/console

btw we need CI when the change is on the makefile?

Member

italoacasas commented Feb 3, 2017

CI: https://ci.nodejs.org/job/node-test-pull-request/6182/console

btw we need CI when the change is on the makefile?

@gibfahn

This comment has been minimized.

Show comment
Hide comment
@gibfahn

gibfahn Feb 3, 2017

Member

@italoacasas Not sure we really need CI, but we might as well run it anyway.

Member

gibfahn commented Feb 3, 2017

@italoacasas Not sure we really need CI, but we might as well run it anyway.

jasnell added a commit that referenced this pull request Feb 3, 2017

doc: clarify msg when doc/api/cli.md not updated
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

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Feb 3, 2017

Member

Landed in 2a295bc

Member

jasnell commented Feb 3, 2017

Landed in 2a295bc

@jasnell jasnell closed this Feb 3, 2017

italoacasas added a commit that referenced this pull request Feb 4, 2017

doc: clarify msg when doc/api/cli.md not updated
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 added a commit to italoacasas/node that referenced this pull request Feb 14, 2017

doc: clarify msg when doc/api/cli.md not updated
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 added a commit to KryDos/node that referenced this pull request Feb 25, 2017

doc: clarify msg when doc/api/cli.md not updated
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 added a commit that referenced this pull request Mar 7, 2017

doc: clarify msg when doc/api/cli.md not updated
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 added a commit that referenced this pull request Mar 7, 2017

doc: clarify msg when doc/api/cli.md not updated
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 added a commit that referenced this pull request Mar 9, 2017

doc: clarify msg when doc/api/cli.md not updated
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 MylesBorins referenced this pull request Mar 9, 2017

Merged

v6.10.1 proposal #11759

MylesBorins added a commit that referenced this pull request Mar 9, 2017

doc: clarify msg when doc/api/cli.md not updated
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 MylesBorins referenced this pull request Mar 9, 2017

Merged

v4.8.1 proposal #11760

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment