Replies: 1 comment 13 replies
-
|
The current resolution came from the understanding that there are 2 types of properties (static and on the prototype. It looks like we have 3 types of properties?
Am I right? (Likely not) |
Beta Was this translation helpful? Give feedback.
-
I'm not sure what you mean, do you refer to Web API renaming as in renaming some Web API pages to conform to this discussion's topic about having instance properties not on the prototype? |
Beta Was this translation helpful? Give feedback.
-
|
I think what @Rumyra is saying—please correct me if I’m wrong—is that they think that it might be worth seeing if renaming Web API pages to more appropriate names will get a lot of positive negative feedback from developers, since renaming Ecma262 API pages might garner similar community feedback. I’m not sure what sort of feedback would necessarily affect this decision—incorrect is incorrect, and titles like “Function.length” or “Array.prototype.length” for function/array lengths in general are observably incorrect and definitely misleading...but it’s fine by me to be cautious and wait to see what happens with a similar situation. |
Beta Was this translation helpful? Give feedback.
-
|
Yeah, but but it seems like this,
is a reference to a separate issue. If so, and anyone knows where that is, might someone point me to it? Otherwise, again, I don't understand any connection/relevance. Although, is anything being done for accessors? That would make sense, and apply to Web APIs, if that's what they were referring to? ... |
Beta Was this translation helpful? Give feedback.
-
|
@phosra I think it's referring to https://github.com/mdn/content/discussions/5121 although I don't have much idea how that's progressing |
Beta Was this translation helpful? Give feedback.
-
|
Ah, understood, I had thought that it might have already been finished. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
To start us off, I'll reference some issues that have already arisen regarding this topic:
mdn/content#16325
mdn/content#17610
mdn/content#18188
https://github.com/mdn/content/discussions/5121
The problem that some readers have with JS documentation is that it currently reads as if to claim that instance properties are instead located on the prototype - which is misleading, but not clarified either.
At the most basic level, this is simply incorrect. MDN makes references to "own" properties, we have articles about prototypes and inheritance, and there are methods such as
Object.hasOwn, so if these are shown as on a prototype, but they aren't, then it may very well lead to confusion, thus leading to more issues about this from readers.For example, in the issue that I raised,
Errorclaims thatcauseis on the prototype, yet it's not even necessarily on the instance.The most accurate way to describe it would be "optionally present on the instance," because if
{ cause }is not present in the constructor, then the property isn't even installed onto the object.This issue applies to
Function.{name, length},Error.{message, cause}, and a few others.It seems that the current resolution is to always use
.prototype., see: mdn/content#16325 (comment).May this be reconsidered?
Beta Was this translation helpful? Give feedback.
All reactions