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

Document PopStateEvent() and PopStateEvent.state #25702

Merged
merged 5 commits into from Mar 29, 2023

Conversation

teoli2003
Copy link
Member

@teoli2003 teoli2003 commented Mar 28, 2023

Description

This PR adds the missing documentation for the following:

  • PopStateEvent()
  • PopStateEvent.state

Motivation

openwebdocs/project#153

Additional details

  • I didn't add an example to PopStateEvent() as the web developer usually does not call this constructor.
  • I removed all uses of window.history throughout MDN: modern usage is the plain history global variable. (One is left in the Window interface where it belongs).
  • I added notes indicating that the History API can only be used in the window global scope (the main thread) and not in workers or worklets.
  • I put PopStateEvent inside the History API group.
  • There would be many more rabbit holes to follow (the guides could be vastly improved), but that's outside the project's scope.
  • The flaws listed are non-written pages unrelated to this work that are in pages I only marginally updated.

Related pull request

@teoli2003 teoli2003 requested a review from a team as a code owner March 28, 2023 12:56
@teoli2003 teoli2003 requested review from sideshowbarker and removed request for a team March 28, 2023 12:56
@github-actions github-actions bot added the Content:WebAPI Web API docs label Mar 28, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Mar 28, 2023

Preview URLs (15 pages)
Flaws (16)

Note! 13 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/Window
Title: Window
Flaw count: 13

  • macros:
    • /en-US/docs/Web/API/Window/returnValue does not exist
    • /en-US/docs/Web/API/Window/setResizable does not exist
    • /en-US/docs/Web/API/Window/animationcancel_event redirects to /en-US/docs/Web/API/Element/animationcancel_event
    • /en-US/docs/Web/API/Window/animationend_event redirects to /en-US/docs/Web/API/Element/animationend_event
    • /en-US/docs/Web/API/Window/animationiteration_event redirects to /en-US/docs/Web/API/Element/animationiteration_event
    • and 8 more flaws omitted

URL: /en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
Title: The structured clone algorithm
Flaw count: 3

  • macros:
    • /en-US/docs/Web/API/CropTarget does not exist
    • /en-US/docs/Web/API/GPUCompilationInfo does not exist
    • /en-US/docs/Web/API/GPUCompilationMessage does not exist
External URLs (3)

URL: /en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm
Title: The structured clone algorithm


URL: /en-US/docs/Web/API/History_API/Example
Title: History navigation example

(comment last updated: 2023-03-29 06:37:14)

@teoli2003 teoli2003 requested a review from a team as a code owner March 28, 2023 13:00
@teoli2003 teoli2003 requested review from dipikabh and removed request for a team March 28, 2023 13:00
Copy link
Contributor

@dawei-wang dawei-wang left a comment

Choose a reason for hiding this comment

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

A couple of typos

files/en-us/web/api/history_api/example/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/history_api/index.md Outdated Show resolved Hide resolved
teoli2003 and others added 2 commits March 28, 2023 21:34
Co-authored-by: dawei-wang <dawei-wang@users.noreply.github.com>
Co-authored-by: dawei-wang <dawei-wang@users.noreply.github.com>
Co-authored-by: Michael[tm] Smith <mike@w3.org>
@sideshowbarker sideshowbarker merged commit 55de680 into mdn:main Mar 29, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants