Skip to content

doc: fix a formatting error in buffer.md#8553

Merged
ChALkeR merged 1 commit into
nodejs:masterfrom
ChALkeR:docfix
Sep 17, 2016
Merged

doc: fix a formatting error in buffer.md#8553
ChALkeR merged 1 commit into
nodejs:masterfrom
ChALkeR:docfix

Conversation

@ChALkeR

@ChALkeR ChALkeR commented Sep 15, 2016 •
edited
Loading

Copy link
Copy Markdown
Member
Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

Fixes an error in doc/api/buffer.md, (see the TypedArray.from() link).

It was treated as a link to "e.g. Uint8Array.from()".

Found with remark-lint (see #8551).

Extracted from #8551, as this could land much faster and should probably be backported if needed.

@ChALkeR ChALkeR added the doc Issues and PRs related to the documentations. label Sep 15, 2016
@nodejs-github-bot nodejs-github-bot added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Sep 15, 2016
@ChALkeR ChALkeR mentioned this pull request Sep 15, 2016
Closed
3 tasks
@ChALkeR

ChALkeR commented Sep 15, 2016

Copy link
Copy Markdown
Member Author

Hold on, one Buffer.allocUnsafe() link is also broken in doc/api/buffer.md#class-method-bufferallocunsafesize.

@ChALkeR

ChALkeR commented Sep 15, 2016

Copy link
Copy Markdown
Member Author

Ok, updated. This now uses [name][] (other text) instead of [name] \(other text).
That looks cleaner and it's the syntax that is used in other places and was used here before cc1318b.

This basically reverts one change from cc1318b and fixes another change.

/cc @mscdex, @jasnell, @trevnorris

ChALkeR referenced this pull request Sep 15, 2016
@mscdex
doc: improve links in Buffer docs
cc1318b 
This commit adds more links and reuses existing link references more.

PR-URL: #7784
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
@mscdex

mscdex commented Sep 15, 2016

Copy link
Copy Markdown
Contributor

I think I'd rather see the 'e.g' portion removed from the first instance and dropping the parens in the second instance.

@ChALkeR

ChALkeR commented Sep 15, 2016 •
edited
Loading

Copy link
Copy Markdown
Member Author

@mscdex You mean removing «(e.g. Uint8Array.from())» completely in the first one?

@mscdex

mscdex commented Sep 15, 2016 •
edited
Loading

Copy link
Copy Markdown
Contributor

@ChALkeR Yeah, I think it's a bit redundant anyway, especially since we've already linked TypedArray.

@ChALkeR

ChALkeR commented Sep 15, 2016

Copy link
Copy Markdown
Member Author

@mscdex Done =).

@mscdex

mscdex commented Sep 15, 2016

Copy link
Copy Markdown
Contributor

LGTM

@ChALkeR

ChALkeR commented Sep 16, 2016

Copy link
Copy Markdown
Member Author

/cc @nodejs/documentation, this should be trivial.

lpinca
lpinca approved these changes Sep 16, 2016
View reviewed changes

@lpinca lpinca left a comment

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.

LGTM

@bengl

bengl commented Sep 17, 2016

Copy link
Copy Markdown
Member

LGTM

1 similar comment
@trevnorris

trevnorris commented Sep 17, 2016

Copy link
Copy Markdown
Contributor

LGTM

@ChALkeR
doc: fix a formatting error in buffer.md
ffe8dff 
It was treated as a link to "e.g. `Uint8Array.from()`".

PR-URL: nodejs#8553
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
@ChALkeR ChALkeR merged commit ffe8dff into nodejs:master Sep 17, 2016
@ChALkeR

ChALkeR commented Sep 17, 2016

Copy link
Copy Markdown
Member Author

Merged in ffe8dff.

Fishrock123 pushed a commit that referenced this pull request Oct 11, 2016
@ChALkeR @Fishrock123
doc: fix a formatting error in buffer.md
2d23227 
It was treated as a link to "e.g. `Uint8Array.from()`".

PR-URL: #8553
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lpinca lpinca lpinca approved these changes

Assignees

No one assigned

Labels

buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@ChALkeR @mscdex @bengl @trevnorris @lpinca @MylesBorins @nodejs-github-bot