Skip to content

doc: link and style parameter types - #4741

Closed
claudiorodriguez wants to merge 2 commits into
nodejs:masterfrom
claudiorodriguez:doc-generate-type-links-2
Closed

doc: link and style parameter types#4741
claudiorodriguez wants to merge 2 commits into
nodejs:masterfrom
claudiorodriguez:doc-generate-type-links-2

Conversation

@claudiorodriguez

@claudiorodriguezclaudiorodriguez commented Jan 18, 2016

Copy link
Copy Markdown
Contributor

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

Replaces PR #4378

@claudiorodriguez

claudiorodriguez commented Jan 18, 2016

Copy link
Copy Markdown
ContributorAuthor

@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

@claudiorodriguezclaudiorodriguez mentioned this pull request Jan 18, 2016
Closed
@r-52r-52 added the doc Issues and PRs related to the documentations. label Jan 18, 2016
@jasnell

jasnell commented Jan 18, 2016

Copy link
Copy Markdown
Member

LGTM
@nodejs/documentation

@jasnell

jasnell commented Jan 18, 2016

Copy link
Copy Markdown
Member

Thank you @fansworld-claudio!

@cjihrig

cjihrig commented Jan 18, 2016

Copy link
Copy Markdown
Contributor

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

thefourtheye
thefourtheye reviewed Jan 18, 2016
View reviewed changes
Comment threaddoc/api/crypto.markdown

@thefourtheyethefourtheyeJan 18, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Other places didn't have colons.

@thefourtheyethefourtheyeJan 18, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

@claudiorodriguezclaudiorodriguezJan 18, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

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

@thefourtheyethefourtheyeJan 18, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Fair enough.

@jasnelljasnellJan 18, 2016

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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

@thefourtheyethefourtheyeJan 18, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

@thefourtheye

thefourtheye commented Jan 18, 2016

Copy link
Copy Markdown
Contributor

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

Fishrock123
Fishrock123 reviewed Jan 18, 2016
View reviewed changes
Comment threaddoc/api/child_process.markdown

@Fishrock123Fishrock123Jan 18, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This link does not appear to work.

@Fishrock123

Fishrock123 commented Jan 18, 2016

Copy link
Copy Markdown
Contributor

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

Fishrock123
Fishrock123 reviewed Jan 18, 2016
View reviewed changes
Comment threadtools/doc/type-parser.js Outdated

@Fishrock123Fishrock123Jan 18, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

@claudiorodriguezclaudiorodriguezJan 19, 2016

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

@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

chrisdickinson commented Jan 19, 2016

Copy link
Copy Markdown
Contributor

This is excellent work! LGTM.

@thefourtheye

thefourtheye commented Jan 19, 2016

Copy link
Copy Markdown
Contributor

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

@claudiorodriguez

claudiorodriguez commented Jan 19, 2016

Copy link
Copy Markdown
ContributorAuthor

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

thefourtheye commented Jan 19, 2016

Copy link
Copy Markdown
Contributor

@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

claudiorodriguez commented Jan 19, 2016

Copy link
Copy Markdown
ContributorAuthor

@thefourtheye is something like this alright?

@thefourtheye

thefourtheye commented Jan 19, 2016

Copy link
Copy Markdown
Contributor

@fansworld-claudio Yup! :-)

@chrisdickinsonchrisdickinson mentioned this pull request Jan 20, 2016
Closed
15 tasks
@silverwind

silverwind commented Feb 4, 2016

Copy link
Copy Markdown
Contributor

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

@claudiorodriguez

claudiorodriguez commented Feb 4, 2016

Copy link
Copy Markdown
ContributorAuthor

@silverwind That should do it, I think

@jasnell

jasnell commented Feb 7, 2016

Copy link
Copy Markdown
Member

LGTM

@silverwind

silverwind commented Feb 8, 2016

Copy link
Copy Markdown
Contributor

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

@claudiorodriguez

claudiorodriguez commented Feb 8, 2016

Copy link
Copy Markdown
ContributorAuthor

@silverwind Done

@claudiorodriguezphpwarlock
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
@claudiorodriguez
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.
silverwind pushed a commit that referenced this pull request Feb 9, 2016
@claudiorodriguez@silverwind
tools: parse types into links in doc html gen
e517efa
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 <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
Reviewed-By: Roman Reiss <me@silverwind.io>
silverwind pushed a commit that referenced this pull request Feb 9, 2016
@claudiorodriguez@silverwind
doc: fix type references for link gen, link css
47e926a
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 <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
Reviewed-By: Roman Reiss <me@silverwind.io>
@silverwind

silverwind commented Feb 9, 2016

Copy link
Copy Markdown
Contributor

Thanks! Landed in e517efa and 47e926a.

@Trott

Trott commented Feb 9, 2016

Copy link
Copy Markdown
Member

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

Trott added a commit to Trott/io.js that referenced this pull request Feb 9, 2016
@Trott
tools,doc: fix linting errors
408d096
Refs: nodejs#4741 (comment)
@silverwind

silverwind commented Feb 9, 2016

Copy link
Copy Markdown
Contributor

Whoops, thanks for picking up the slack @Trott.

This was referenced Feb 9, 2016
Closed
Closed
silverwind pushed a commit that referenced this pull request Feb 9, 2016
@Trott@silverwind
tools,doc: fix linting errors
1693349
Refs: #4741 (comment)
PR-URL: #5161
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
rvagg pushed a commit that referenced this pull request Feb 10, 2016
@claudiorodriguez@rvagg
tools: parse types into links in doc html gen
22c8d50
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 <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
Reviewed-By: Roman Reiss <me@silverwind.io>
rvagg pushed a commit that referenced this pull request Feb 10, 2016
@claudiorodriguez@rvagg
doc: fix type references for link gen, link css
529e749
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 <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
Reviewed-By: Roman Reiss <me@silverwind.io>
rvagg pushed a commit that referenced this pull request Feb 10, 2016
@Trott@rvagg
tools,doc: fix linting errors
bcc26f7
Refs: #4741 (comment)
PR-URL: #5161
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
@MylesBorins

MylesBorins commented Feb 18, 2016

Copy link
Copy Markdown
Contributor

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

@MylesBorinsMylesBorins mentioned this pull request Feb 18, 2016
Closed
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
@claudiorodriguezMyles Borins
tools: parse types into links in doc html gen
cdf18c2
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 <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
@claudiorodriguezMyles Borins
doc: fix type references for link gen, link css
9f95e1f
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 <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
@TrottMyles Borins
tools,doc: fix linting errors
d4385c0
Refs: #4741 (comment)
PR-URL: #5161
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
@claudiorodriguezMyles Borins
tools: parse types into links in doc html gen
154772c
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 <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
@claudiorodriguezMyles Borins
doc: fix type references for link gen, link css
73e0195
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 <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Feb 22, 2016
@TrottMyles Borins
tools,doc: fix linting errors
0100639
Refs: #4741 (comment)
PR-URL: #5161
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 2, 2016
@claudiorodriguezMyles Borins
tools: parse types into links in doc html gen
acffcf7
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 <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Mar 2, 2016
@claudiorodriguezMyles Borins
doc: fix type references for link gen, link css
7acbe87
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 <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Chris Dickinson <chris@neversaw.us>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Mar 2, 2016
@TrottMyles Borins
tools,doc: fix linting errors
7c1cd9a
Refs: #4741 (comment)
PR-URL: #5161
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

10 participants

@claudiorodriguez@jasnell@cjihrig@thefourtheye@Fishrock123@chrisdickinson@silverwind@Trott@MylesBorins@r-52