doc: add Buffer.lastIndexOf #4933
Conversation
|
Can you order this alphabetically like the rest? |
r-52
added
buffer
dcposch
force-pushed
the
doc
branch
3 times, most recently
from
b80c2dc to
a31e635
Compare
|
@tflanagan fixed |
|
@dcposch, thanks :) |
|
Also, it'd be good to expand the parameter bits to be in-line with this other buffers PR: #4873 |
|
@Qard fixed |
| Identical to [`Buffer#indexOf()`][], but searches the Buffer from back to front | ||
| instead of front to back. Returns the starting index position of `value` in | ||
| Buffer or `-1` if the Buffer does not contain `value`. The `value` can be a | ||
| String, Buffer or Number. Strings are by default interpreted as UTF8. If |
There was a problem hiding this comment.
Also you should need to mention the default encoding at all since it is listed above.
There was a problem hiding this comment.
It's rendered "UTF8" everywhere else in this file. I think this is fine.
dcposch
force-pushed
the
doc
branch
2 times, most recently
from
5d3105a to
82733a2
Compare
|
@Qard looks more dece now? |
| @@ -577,6 +577,46 @@ for (var key of buf.keys()) { | |||
| // 5 | |||
| ``` | |||
|
|
|||
| ### buf.lastIndexOf(value[, byteOffset][, encoding]) | |||
|
|
|||
| * `value` {String, Buffer or Number} | |||
There was a problem hiding this comment.
Can you wrap each type separately, please?
There was a problem hiding this comment.
It's done like this everywhere else in the file -- eg indexOf, includes, and fill
I can change all of those places if you want--LMK
There was a problem hiding this comment.
@Qard added a commit that wraps types separately everywhere there's a list
There was a problem hiding this comment.
Unfortunately wrapping the three separately confuses the JSON documentation generation IIRC.
|
LGTM |
| `byteOffset`. | ||
|
|
||
| ```js | ||
| const buf = new Buffer('this buffer is a buffer'); |
There was a problem hiding this comment.
Could you please add
const Buffer = require('buffer').Buffer;
There was a problem hiding this comment.
Is it needed for the linter ? Buffer is global.
There was a problem hiding this comment.
The linter does complain about it
There was a problem hiding this comment.
@tflanagan no other code sample in this doc does that
which linter are you talking about? make test and make doc both run without errors
|
@jasnell thanks for the review. i just rebased because there were conflicts. the PR is even smaller now -- it only adds the |
|
LGTM |
|
how does this relate to #4846? |
|
That's what I figured... any reason not to simply bundle the two commits into the single PR #4846? Would make it easier to land. |
|
Agreed, it's better that docs commits of new features are included in the PR of the feature itself and just mention @nodejs/documentation in the issue to summon us docs folks for review. |
Complements #4604
Together they fix #4846