content icon indicating copy to clipboard operation
content copied to clipboard

Confusing description of Worker message event

Open briancodes opened this issue 3 years ago • 9 comments

MDN URL

https://developer.mozilla.org/en-US/docs/Web/API/Worker/message_event

What specific section or headline is this issue about?

Top level description

What information was incorrect, unhelpful, or incomplete?

The message event is fired on a Worker object when the worker's parent receives a message from its worker

What did you expect to see?

A clearer description of the event

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

No response

MDN metadata

Page report details
  • Folder: en-us/web/api/worker/message_event
  • MDN URL: https://developer.mozilla.org/en-US/docs/Web/API/Worker/message_event
  • GitHub URL: https://github.com/mdn/content/blob/main/files/en-us/web/api/worker/message_event/index.md
  • Last commit: https://github.com/mdn/content/commit/840db6342cecc2bd24cadf780ba7678ddcc25b1f
  • Document last modified: 2022-07-23T16:30:18.000Z

briancodes avatar Aug 02 '22 21:08 briancodes

Hey @sideshowbarker , Could you please tell me that with help wanted tag, are you asking the creator of the issue to elaborate more on the issue or does it mean that you are looking for someone to work on the issue? If it means the later, I would like to take it up.

7777chaitanya avatar Aug 03 '22 16:08 7777chaitanya

Could you please tell me that with help wanted tag, are you asking the creator of the issue to elaborate more on the issue or does it mean that you are looking for someone to work on the issue?

It means we are looking for someone to work on the issue

sideshowbarker avatar Aug 04 '22 00:08 sideshowbarker

@briancodes, you have linked to mouseup & Worker: message event. I see in the top heading of both these events—we have used fired to describe the firing up of an event.

The different terms used for very similar concepts can be confusing. For example with mouseup it says the event is fired at an Element

Could you please tell me what do you mean by different terms as I see that firing is the term used—in the top heading of all event docs?

Would it be an idea to have a standardized way of describing events - maybe using the terms like trigger, dispatch and listen

Do you mean that we need to change all the occurrences of fired to triggered and fires to triggers across all of the event top heading's?

7777chaitanya avatar Aug 04 '22 05:08 7777chaitanya

@Chaitanya7666 You're right about the fired and firing terms - they're pretty consistent throughout the site

I guess it was more the "fired on an object" vs "fired at an element", but it's probably fine as is

briancodes avatar Aug 04 '22 08:08 briancodes

@Chaitanya7666 You're right about the fired and firing terms - they're pretty consistent throughout the site

I guess it was more the "fired on an object" vs "fired at an element", but it's probably fine as is

@sideshowbarker Requesting your thoughts on this. Could you please give me any suggestions on how to take this issue further?

7777chaitanya avatar Aug 04 '22 09:08 7777chaitanya

@sideshowbarker Requesting your thoughts on this. Could you please give me any suggestions on how to take this issue further?

I don’t really have any specific thoughts on this, and no particular suggestions to give. Part of the work of resolving an issue — maybe the main work involved — is evaluating the issue on one’s own and making decisions about how to proceed.

sideshowbarker avatar Aug 05 '22 11:08 sideshowbarker

I guess it was more the "fired on an object" vs "fired at an element", but it's probably fine as is

@briancodes I get what you are saying. Let me read about Workers once—to see if it's non-intuitive for people to understand the difference between the statements that you have mentioned before I jump to a conclusion.

7777chaitanya avatar Aug 06 '22 03:08 7777chaitanya

@sideshowbarker, I think that the current description is good and I don't see any further improvements that could be done to it and so I think that this issue can be closed.

7777chaitanya avatar Aug 09 '22 14:08 7777chaitanya

@sideshowbarker, I think that the current description is good and I don't see any further improvements that could be done to it and so I think that this issue can be closed.

@briancodes What do you think?

sideshowbarker avatar Aug 10 '22 02:08 sideshowbarker

Closing because everyone seems to think this is fine as-is.

Josh-Cena avatar Sep 11 '22 03:09 Josh-Cena