doc: clarify the parameter byteOffset for lastIndexOf method of Buffer

[arkerone]

I suggest to clarify the parameter byteOffset for the lastIndexOf method of Buffer.

Currently, the doc says :
"Where to begin searching in buf"

But in my opinion, it's not just. The parameter is more :
"the index of the last byte in buf to be considered as the beginning of a match."

What do you think about that ?

[jasnell]

/cc @Trott

[Trott]

I find the proposed wording harder to understand, but maybe that's just me. Do others think it is either more precise or easier to read? @nodejs/documentation

[DerekNonGeneric]

Suggested change

	* `byteOffset` {integer} The index of the last byte in `buf` to be considered
	as the beginning of a match. If negative, then offset is calculated
	* `byteOffset` {integer} The last zero-based index (in bytes) of `buf` to be
	considered as the beginning of a match. If negative, then offset is calculated

My 2¢, but given that Buffer is a subclass of Uint8Array, we may be able to use some of the language used by MDN if it's more suitable.

The Buffer class is a subclass of JavaScript's Uint8Array class and extends it with methods that cover additional use cases.

See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/byteOffset

[arkerone]

I find the proposed wording harder to understand, but maybe that's just me. Do others think it is either more precise or easier to read? @nodejs/documentation

I was inspired by the documentation concerning the lastIndexOf method of string (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf)) but we can also draw inspiration from the documentation of TypedArray (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/lastIndexOf) as suggested by @DerekNonGeneric

[aduh95]

This would need a rebase if we still want to land it.

[github-actions]

This issue/PR was marked as stalled, it will be automatically closed in 30 days. If it should remain open, please leave a comment explaining why it should remain open.

[github-actions]

Closing this because it has stalled. Feel free to reopen if this issue/PR is still relevant, or to ping the collaborator who labelled it stalled if you have any questions.