Object.keysToArray documentation #114
Conversation
src/Core__Object.res
Outdated
| ## Specifications | ||
| - [ECMAScript Language Specification](https://tc39.es/ecma262/multipage/fundamental-objects.html#sec-object.keys) | ||
| - [Object.keys on MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/keys) |
There was a problem hiding this comment.
We've not used a separate subtitle for specifications before, but rather just linked to MDN on a separate line, like "See Object.keys on MDN". I like your subtitle and I think we should consider doing that instead further down the line. So, I propose we change this to follow how we've done the rest ("See Object.keys on MDN"), and open a separate issue where we can discuss whether we should move everything to a separate subtitle.
Sounds good?
There was a problem hiding this comment.
I don't know where I got that. I'll change it everywhere. One issue is that in the Intellisense pop up there isn't much space and the references can cause the examples to scroll off the screen. So sometimes I'll add it to the summary sentence to reduce vertical scroll and maybe other times as a separate paragraph. The "Examples" header seems too big in that pop up.
There was a problem hiding this comment.
This is what I'll do most places.
There was a problem hiding this comment.
Do you want to change "keysToArray" to "keys" everywhere?
There was a problem hiding this comment.
Let's keep the original naming for now, and we can revisit later.
There was a problem hiding this comment.
I'm struggling a bit to see the rationale for keeping the name as-is, given that the foremost guiding principle is familiarity for JS developers. This naming is also inconsistent with just about everything else in the library. There is no other function with a ToArray suffix.
|
Consolidated into #117 |
Object.keysToArray documentation. Why not just call this "keys"? Shorter and matches Javascript. I see a few places in the code with
keysToArray- should change it everywhere. Map just useskeysandvalues.