Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding the Window Proxy page #4630

Merged
merged 4 commits into from
May 5, 2021

Conversation

jamesaucode
Copy link
Contributor

What was wrong/why is this fix needed? (quick summary only)

It's referenced in several pages including the page I am refactoring: Window.open, and other pages like contentWindow, MessageEvent.source etc. So it will be nice to have a page dedicated to it.

MDN URL of main page changed

N/A, new page will be created with slug 'Glossary/Window_Proxy'

Issue number (if there is an associated issue)

N/A

Anything else that could help us review it

I am actually not sure if this should go under Glossary or Web/API ? Correct me if I am wrong but we don't instantiate a WindowProxy project, but we work with the Window object. When we check the instance of the global window object, it also returns Window. (window instanceof Window) === true. Let me know where this page should be in.

@jamesaucode jamesaucode requested a review from a team as a code owner April 30, 2021 20:50
@jamesaucode jamesaucode requested review from chrisdavidmills and removed request for a team April 30, 2021 20:50
@github-actions
Copy link
Contributor

github-actions bot commented Apr 30, 2021

Preview URLs

Flaws

None! 🎉

External URLs

URL: /en-US/docs/Glossary/Window_Proxy
Title: Window Proxy
on GitHub

(this comment was updated 2021-04-30 21:00:37.029251)

(this comment was updated 2021-05-04 08:49:00.380367)

(this comment was updated 2021-05-05 07:06:22.593479)

Copy link
Contributor

@chrisdavidmills chrisdavidmills left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i've given this a copy edit, and the language now sounds good. Thanks for the contribution @jamesaucode ! I also think that this belongs in the glossary, so the position is OK.

I'd also like someone else who know a bit more about such internals to have a look at this, and give a second opinion on the content. @sideshowbarker can you have a look when you get the chance?

@sideshowbarker sideshowbarker self-assigned this May 5, 2021
@sideshowbarker
Copy link
Collaborator

I'd also like someone else who know a bit more about such internals to have a look at this, and give a second opinion on the content. @sideshowbarker can you have a look when you get the chance?

Thanks for the heads-up. In 5927c96 I moved it to being named WindowProxy — since it’s actually an object (though not one directly exposed to JavaScript0 — and copy edited further.

I agree we should have this documented in MDN, and the Glossary is the right place. WindowProxy is inherently esoteric, and developers mostly don’t ever need to think about it — but that said, among the reasons we should still document it (despite its esoteric nature) are that in sections of the HTML spec written specifically for developers, such as https://html.spec.whatwg.org/multipage/browsers.html#navigating-nested-browsing-contexts-in-the-dom, the spec explicitly says, for example, “window.parent: Returns the WindowProxy for the parent browsing context.”

So in that sense at least, WindowProxy is something exposed to developers that they should know about.

@sideshowbarker sideshowbarker merged commit 8454e66 into mdn:main May 5, 2021
@sideshowbarker
Copy link
Collaborator

@jamesaucode Thanks much — this is a great addition to the docs

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants