doc: link and style parameter types #4741

claudiorodriguez · 2016-01-18T12:39:37Z

Changes the parsing of parameter types, links to MDN or
nodejs docs. See #4350

Replaces PR #4378

claudiorodriguez · 2016-01-18T12:42:46Z

@jasnell Remade the PR fresh off master to make sure everything is clean, since this touches a bunch of docs the merging may produce some conflicts for other open PRs, but they should be minor

jasnell · 2016-01-18T16:39:49Z

LGTM
@nodejs/documentation

jasnell · 2016-01-18T16:40:17Z

Thank you @fansworld-claudio!

cjihrig · 2016-01-18T17:10:23Z

LGTM, but I'll defer to the docs team.

thefourtheye · 2016-01-18T17:15:21Z

doc/api/crypto.markdown

@@ -666,8 +666,8 @@ The `private_key` argument can be an object or a string. If `private_key` is a
 string, it is treated as a raw key with no passphrase. If `private_key` is an
 object, it is interpreted as a hash containing two properties:

-* `key` : A string holding the PEM encoded private key
-* `passphrase` : A string of passphrase for the private key
+* `key` : {String} - PEM encoded private key


Other places didn't have colons.

Also, it would be better if the type and description seperator is consistent in all the files.

@thefourtheye I agree, but unfortunately everything was already inconsistent. I think refactoring that belongs to another PR IMHO

Fair enough.

Yeah, there are quite a few areas here where incremental improvements need to be made. We'll get there but breaking it up into smaller incremental changes is likely best

@jasnell Yup, I completely agree. That would be much easier to review as well :)

thefourtheye · 2016-01-18T18:06:37Z

LGTM and Thanks a lot @fansworld-claudio :-)

Fishrock123 · 2016-01-18T18:13:03Z

doc/api/child_process.markdown

@@ -641,7 +641,7 @@ See `waitpid(2)`.
 ### Event: 'message'

 * `message` {Object} a parsed JSON object or primitive value.
-* `sendHandle` {Handle object} a [`net.Socket`][] or [`net.Server`][] object, or
+* `sendHandle` {Handle} a [`net.Socket`][] or [`net.Server`][] object, or


This link does not appear to work.

Fishrock123 · 2016-01-18T18:13:23Z

I like this. In any case it's a step forward.

Fishrock123 · 2016-01-18T18:14:32Z

tools/doc/type-parser.js

+];
+const typeMap = {
+  'Buffer': 'buffer.html#buffer_class_buffer',
+  'Handle': 'net.html#net_server_listen_handle_callback',


Handle probably needs to be more specific, there are many types of handles, although they all inherit from AsyncWrap afaik.

@Fishrock123 I'm a bit out of my depth there. I'm fixing the link, but no idea where to link to exactly other than that.

chrisdickinson · 2016-01-19T03:12:04Z

This is excellent work! LGTM.

thefourtheye · 2016-01-19T03:35:51Z

I think it would be better if the tools part and the doc part are in different commits.

claudiorodriguez · 2016-01-19T14:13:30Z

Corrected a couple of things noted, thanks everyone. @thefourtheye you mean two commits in a single PR, or two separate PRs? I could do any of the two, if the current contents of the PR are okay

thefourtheye · 2016-01-19T15:34:35Z

@fansworld-claudio Given the fact that it has been reviewed by quite a few collaborators and owners, I would say splitting into two commits in this PR itself would be better.

claudiorodriguez · 2016-01-19T16:06:45Z

@thefourtheye is something like this alright?

thefourtheye · 2016-01-19T16:11:05Z

@fansworld-claudio Yup! :-)

silverwind · 2016-02-04T18:35:27Z

The buffer part of this was landed recently in 6ad1f7b. @fansworld-claudio could you update this PR?

claudiorodriguez · 2016-02-04T23:46:20Z

@silverwind That should do it, I think

jasnell · 2016-02-07T20:18:05Z

LGTM

silverwind · 2016-02-08T17:39:49Z

LGTM. @fansworld-claudio can you rebase once more?

claudiorodriguez · 2016-02-08T20:20:30Z

@silverwind Done

Changes the parsing of parameter types in the doc html gen Links to either MDN or nodejs docs depending on type See nodejs#4350

Fixes several type references in the docs so that the doc html gen tool that parses them can put the correct links in. Changes css styling for the generated type links.

Changes the parsing of parameter types in the doc html gen Links to either MDN or nodejs docs depending on type See #4350 PR-URL: #4741 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Chris Dickinson <[email protected]> Reviewed-By: Roman Reiss <[email protected]>

Fixes several type references in the docs so that the doc html gen tool that parses them can put the correct links in. Changes css styling for the generated type links. PR-URL: #4741 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Chris Dickinson <[email protected]> Reviewed-By: Roman Reiss <[email protected]>

silverwind · 2016-02-09T12:13:22Z

Thanks! Landed in e517efa and 47e926a.

Trott · 2016-02-09T17:35:31Z

This change does not lint cleanly with the current linting rules. I'll submit a PR to fix.

Refs: nodejs#4741 (comment)

silverwind · 2016-02-09T17:38:34Z

Whoops, thanks for picking up the slack @Trott.

Refs: #4741 (comment) PR-URL: #5161 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Myles Borins <[email protected]>

Changes the parsing of parameter types in the doc html gen Links to either MDN or nodejs docs depending on type See #4350 PR-URL: #4741 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Chris Dickinson <[email protected]> Reviewed-By: Roman Reiss <[email protected]>

Fixes several type references in the docs so that the doc html gen tool that parses them can put the correct links in. Changes css styling for the generated type links. PR-URL: #4741 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Chris Dickinson <[email protected]> Reviewed-By: Roman Reiss <[email protected]>

Refs: #4741 (comment) PR-URL: #5161 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Myles Borins <[email protected]>

MylesBorins · 2016-02-18T02:16:28Z

This change is not landing nicely into LTS. We need to get a backlog of commits updated for this to work

Changes the parsing of parameter types in the doc html gen Links to either MDN or nodejs docs depending on type See #4350 PR-URL: #4741 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Chris Dickinson <[email protected]> Reviewed-By: Roman Reiss <[email protected]>

Fixes several type references in the docs so that the doc html gen tool that parses them can put the correct links in. Changes css styling for the generated type links. PR-URL: #4741 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Chris Dickinson <[email protected]> Reviewed-By: Roman Reiss <[email protected]>

Refs: #4741 (comment) PR-URL: #5161 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Myles Borins <[email protected]>

Changes the parsing of parameter types in the doc html gen Links to either MDN or nodejs docs depending on type See #4350 PR-URL: #4741 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Chris Dickinson <[email protected]> Reviewed-By: Roman Reiss <[email protected]>

Fixes several type references in the docs so that the doc html gen tool that parses them can put the correct links in. Changes css styling for the generated type links. PR-URL: #4741 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Chris Dickinson <[email protected]> Reviewed-By: Roman Reiss <[email protected]>

Refs: #4741 (comment) PR-URL: #5161 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Myles Borins <[email protected]>

Changes the parsing of parameter types in the doc html gen Links to either MDN or nodejs docs depending on type See #4350 PR-URL: #4741 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Chris Dickinson <[email protected]> Reviewed-By: Roman Reiss <[email protected]>

Fixes several type references in the docs so that the doc html gen tool that parses them can put the correct links in. Changes css styling for the generated type links. PR-URL: #4741 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Chris Dickinson <[email protected]> Reviewed-By: Roman Reiss <[email protected]>

Refs: #4741 (comment) PR-URL: #5161 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Myles Borins <[email protected]>

claudiorodriguez mentioned this pull request Jan 18, 2016

doc: make types in API docs not blend visually with description #3244

Closed

r-52 added the doc Issues and PRs related to the documentations. label Jan 18, 2016

jasnell added the lts-watch-v4.x label Jan 18, 2016

thefourtheye reviewed Jan 18, 2016
View reviewed changes

Fishrock123 reviewed Jan 18, 2016
View reviewed changes

claudiorodriguez force-pushed the doc-generate-type-links-2 branch from 18e2485 to 453f858 Compare January 19, 2016 14:11

claudiorodriguez force-pushed the doc-generate-type-links-2 branch from 453f858 to 16aec57 Compare January 19, 2016 14:20

claudiorodriguez force-pushed the doc-generate-type-links-2 branch from 16aec57 to f1db99c Compare January 19, 2016 16:05

chrisdickinson mentioned this pull request Jan 20, 2016

Doctool: Remark plugins nodejs/docs#61

Closed

15 tasks

claudiorodriguez force-pushed the doc-generate-type-links-2 branch from f1db99c to 535578a Compare February 4, 2016 23:45

claudiorodriguez added 2 commits February 9, 2016 02:15

tools: parse types into links in doc html gen

58b5af2

Changes the parsing of parameter types in the doc html gen Links to either MDN or nodejs docs depending on type See nodejs#4350

doc: fix type references for link gen, link css

d269f8e

Fixes several type references in the docs so that the doc html gen tool that parses them can put the correct links in. Changes css styling for the generated type links.

claudiorodriguez force-pushed the doc-generate-type-links-2 branch from fe51d1a to d269f8e Compare February 9, 2016 05:17

silverwind closed this Feb 9, 2016

Trott added a commit to Trott/io.js that referenced this pull request Feb 9, 2016

tools,doc: fix linting errors

408d096

Refs: nodejs#4741 (comment)

This was referenced Feb 9, 2016

tools,doc: fix linting errors #5161

Closed

Enable and require use of node-accept-pull-request? nodejs/build#324

Closed

silverwind pushed a commit that referenced this pull request Feb 9, 2016

tools,doc: fix linting errors

1693349

Refs: #4741 (comment) PR-URL: #5161 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Myles Borins <[email protected]>

rvagg pushed a commit that referenced this pull request Feb 10, 2016

tools,doc: fix linting errors

bcc26f7

Refs: #4741 (comment) PR-URL: #5161 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Myles Borins <[email protected]>

MylesBorins mentioned this pull request Feb 18, 2016

doc: improve scrolling, various CSS tweaks #5198

Closed

MylesBorins pushed a commit that referenced this pull request Feb 22, 2016

tools,doc: fix linting errors

d4385c0

Refs: #4741 (comment) PR-URL: #5161 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Myles Borins <[email protected]>

MylesBorins added land-on-v4.x and removed lts-watch-v4.x labels Feb 22, 2016

MylesBorins pushed a commit that referenced this pull request Feb 22, 2016

tools,doc: fix linting errors

0100639

Refs: #4741 (comment) PR-URL: #5161 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Myles Borins <[email protected]>

MylesBorins pushed a commit that referenced this pull request Mar 2, 2016

tools,doc: fix linting errors

7c1cd9a

Refs: #4741 (comment) PR-URL: #5161 Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Myles Borins <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: link and style parameter types #4741

doc: link and style parameter types #4741

claudiorodriguez commented Jan 18, 2016

claudiorodriguez commented Jan 18, 2016

jasnell commented Jan 18, 2016

jasnell commented Jan 18, 2016

cjihrig commented Jan 18, 2016

thefourtheye Jan 18, 2016

thefourtheye Jan 18, 2016

claudiorodriguez Jan 18, 2016

thefourtheye Jan 18, 2016

jasnell Jan 18, 2016

thefourtheye Jan 18, 2016

thefourtheye commented Jan 18, 2016

Fishrock123 Jan 18, 2016

Fishrock123 commented Jan 18, 2016

Fishrock123 Jan 18, 2016

claudiorodriguez Jan 19, 2016

chrisdickinson commented Jan 19, 2016

thefourtheye commented Jan 19, 2016

claudiorodriguez commented Jan 19, 2016

thefourtheye commented Jan 19, 2016

claudiorodriguez commented Jan 19, 2016

thefourtheye commented Jan 19, 2016

silverwind commented Feb 4, 2016

claudiorodriguez commented Feb 4, 2016

jasnell commented Feb 7, 2016

silverwind commented Feb 8, 2016

claudiorodriguez commented Feb 8, 2016

silverwind commented Feb 9, 2016

Trott commented Feb 9, 2016

silverwind commented Feb 9, 2016

MylesBorins commented Feb 18, 2016

doc: link and style parameter types #4741

doc: link and style parameter types #4741

Conversation

claudiorodriguez commented Jan 18, 2016

claudiorodriguez commented Jan 18, 2016

jasnell commented Jan 18, 2016

jasnell commented Jan 18, 2016

cjihrig commented Jan 18, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thefourtheye commented Jan 18, 2016

Choose a reason for hiding this comment

Fishrock123 commented Jan 18, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisdickinson commented Jan 19, 2016

thefourtheye commented Jan 19, 2016

claudiorodriguez commented Jan 19, 2016

thefourtheye commented Jan 19, 2016

claudiorodriguez commented Jan 19, 2016

thefourtheye commented Jan 19, 2016

silverwind commented Feb 4, 2016

claudiorodriguez commented Feb 4, 2016

jasnell commented Feb 7, 2016

silverwind commented Feb 8, 2016

claudiorodriguez commented Feb 8, 2016

silverwind commented Feb 9, 2016

Trott commented Feb 9, 2016

silverwind commented Feb 9, 2016

MylesBorins commented Feb 18, 2016