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.

Sign up for GitHub

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

Jump to bottom

Proposal: Documentation - Change style of parameter type #4350

Closed
SetTrend opened this issue Dec 18, 2015 · 5 comments
Closed

Proposal: Documentation - Change style of parameter type #4350

SetTrend opened this issue Dec 18, 2015 · 5 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@SetTrend
Copy link

This is just a minor one. Yet, it's confusing when reading:

In the docs the parameter description style doesn't distinguish between the parameter's type and the actual description. There is not even a punctuation character separating these two (see image below).

I suggest to use a distinct style for a parameter's type.

node
@mscdex mscdex added the doc Issues and PRs related to the documentations. label Dec 19, 2015
@mscdex
Copy link
Contributor

mscdex commented Dec 19, 2015

/cc @nodejs/documentation

@claudiorodriguez
Copy link
Contributor

To clarify, this is actually a css issue - specifically in https://github.com/nodejs/node/blob/master/doc/api_assets/style.css#L351 - no idea what the best way to style it is, though.

@tflanagan
Copy link
Contributor

Better yet, make those types links to either MDN documentation for Numbers, Objects, etc, and Nodejs documentation for Handle Objects, Streams, etc.

@SetTrend
Copy link
Author

👍

@claudiorodriguez
Copy link
Contributor

That is possible to do in the markdown-to-html doc tool. I'll work on a PR

@claudiorodriguez claudiorodriguez mentioned this issue Dec 21, 2015
Closed
claudiorodriguez added a commit to claudiorodriguez/node that referenced this issue Dec 21, 2015
@claudiorodriguez
doc: link and style parameter types
baa7875 
Changes the parsing of parameter types, links to MDN or
nodejs docs. See nodejs#4350
example: "* {Object}" -> "* <link to MDN><Object></link>"
@brendanashworth brendanashworth mentioned this issue Jan 1, 2016
Closed
@claudiorodriguez claudiorodriguez mentioned this issue Jan 18, 2016
Closed
claudiorodriguez added a commit to claudiorodriguez/node that referenced this issue Feb 9, 2016
@claudiorodriguez
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
silverwind pushed a commit that referenced this issue 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 <[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]>
rvagg pushed a commit that referenced this issue 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 <[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]>
MylesBorins pushed a commit that referenced this issue Feb 22, 2016
@claudiorodriguez
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 <[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]>
MylesBorins pushed a commit that referenced this issue Feb 22, 2016
@claudiorodriguez
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 <[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]>
MylesBorins pushed a commit that referenced this issue Mar 2, 2016
@claudiorodriguez
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 <[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]>
jasnell added a commit to jasnell/node that referenced this issue Apr 2, 2016
@jasnell
doc: minor argument formatting in stream.markdown
10bbb88 
Fixes: nodejs#4350
@jasnell jasnell mentioned this issue Apr 2, 2016
Closed
2 tasks
@jasnell jasnell closed this as completed in 63e743d Apr 2, 2016
MylesBorins pushed a commit that referenced this issue Apr 5, 2016
@jasnell
doc: minor argument formatting in stream.markdown
7337ef6 
Fixes: #4350
PR-URL: #6016
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
Reviewed-By: Roman Klauke <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
MylesBorins pushed a commit that referenced this issue May 3, 2016
@jasnell
doc: minor argument formatting in stream.markdown
4b8e2bd 
Fixes: #4350
PR-URL: #6016
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
Reviewed-By: Roman Klauke <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
MylesBorins pushed a commit that referenced this issue May 6, 2016
@jasnell
doc: minor argument formatting in stream.markdown
06caef0 
Fixes: #4350
PR-URL: #6016
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
Reviewed-By: Roman Klauke <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
MylesBorins pushed a commit that referenced this issue May 18, 2016
@jasnell
doc: minor argument formatting in stream.markdown
6d56009 
Fixes: #4350
PR-URL: #6016
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Sakthipriyan Vairamani <[email protected]>
Reviewed-By: Roman Klauke <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: minor argument formatting in stream.markdown jasnell/node
4 participants
@mscdex @claudiorodriguez @tflanagan @SetTrend