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

doc: apply consistent styling for functions #4974

Closed
wants to merge 2 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Jan 30, 2016

Always refer to (for example) assert.deepEqual() as
assert.deepEqual() and never as assert.deepEqual.

/cc @nodejs/documentation @thefourtheye

Always refer to (for example) `assert.deepEqual()` as
`assert.deepEqual()` and never as `assert.deepEqual`.
@Trott Trott added doc Issues and PRs related to the documentations. lts-watch-v4.x labels Jan 30, 2016
@benjamingr
Copy link
Member

LGTM.

@@ -89,7 +89,7 @@ parameter is undefined, a default error message is assigned.

## assert.deepStrictEqual(actual, expected[, message])

Generally identical to `assert.deepEqual` with the exception that primitive
Generally identical to `assert.deepEqual()` with the exception that primitive
Copy link
Member

Choose a reason for hiding this comment

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

Nitpick, but shouldn't that also be a link (i.e. [assert.deepEqual()][] )

Copy link
Member Author

Choose a reason for hiding this comment

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

Will fix that!

@TimothyGu
Copy link
Member

Looks good. I'm planning on submitting a more comprehensive PR that fixes all such cases in the API documentation, but for now this can go in.

@thefourtheye
Copy link
Contributor

Awesome. LGTM. I am on Mobile. I couldn't check all the places in this file. Hope you took care of all of them

@Qard
Copy link
Member

Qard commented Jan 30, 2016

LGTM

@Trott
Copy link
Member Author

Trott commented Feb 2, 2016

Just added one minor change to this at the suggestion of @benjamingr.

@thefourtheye and/or @Qard: Can you check the minor update and confirm that it still looks good to you?

@Qard
Copy link
Member

Qard commented Feb 2, 2016

Yep, LGTM. 👍

Trott added a commit to Trott/io.js that referenced this pull request Feb 2, 2016
Always refer to (for example) `assert.deepEqual()` as
`assert.deepEqual()` and never as `assert.deepEqual`.

PR-URL: nodejs#4974
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
@Trott
Copy link
Member Author

Trott commented Feb 2, 2016

Landed in 3874f32

@Trott Trott closed this Feb 2, 2016
rvagg pushed a commit that referenced this pull request Feb 8, 2016
Always refer to (for example) `assert.deepEqual()` as
`assert.deepEqual()` and never as `assert.deepEqual`.

PR-URL: #4974
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
@MylesBorins
Copy link
Member

blocked by e436272

@eljefedelrodeodeljefe
Copy link
Contributor

@thealphanerd can I help there?

@MylesBorins
Copy link
Member

@eljefedelrodeodeljefe not just yet. That commit itself is blocked by another one.

MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
Always refer to (for example) `assert.deepEqual()` as
`assert.deepEqual()` and never as `assert.deepEqual`.

PR-URL: #4974
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
Always refer to (for example) `assert.deepEqual()` as
`assert.deepEqual()` and never as `assert.deepEqual`.

PR-URL: #4974
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
MylesBorins pushed a commit that referenced this pull request Mar 2, 2016
Always refer to (for example) `assert.deepEqual()` as
`assert.deepEqual()` and never as `assert.deepEqual`.

PR-URL: #4974
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
Always refer to (for example) `assert.deepEqual()` as
`assert.deepEqual()` and never as `assert.deepEqual`.

PR-URL: nodejs#4974
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
@Trott Trott deleted the assert-ok branch January 13, 2022 22:42
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants