Skip to content

fix: remove unrelated add() method reference from openCursor() doc#38998

Merged
Josh-Cena merged 2 commits intomdn:mainfrom
omlahore:fix-opencursor-wrong-paragraph
Apr 6, 2025
Merged

fix: remove unrelated add() method reference from openCursor() doc#38998
Josh-Cena merged 2 commits intomdn:mainfrom
omlahore:fix-opencursor-wrong-paragraph

Conversation

@omlahore
Copy link
Copy Markdown
Contributor

@omlahore omlahore commented Apr 6, 2025

Description

Removed an unrelated paragraph from the IDBObjectStore.openCursor() documentation that incorrectly referenced the add() method.

Motivation

The second paragraph was confusing and not relevant to openCursor(). It referred to handling the result of add(), which does not apply to cursors and could mislead readers.

Additional details

MDN page: https://developer.mozilla.org/en-US/docs/Web/API/IDBObjectStore/openCursor

Related issues and pull requests

Fixes #38985

@omlahore omlahore requested a review from a team as a code owner April 6, 2025 11:13
@omlahore omlahore requested review from sideshowbarker and removed request for a team April 6, 2025 11:13
@github-actions github-actions bot added Content:WebAPI Web API docs size/xs [PR only] 0-5 LoC changed labels Apr 6, 2025

To determine if the add operation has completed successfully, listen for the results's
`success` event.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[mdn-linter] reported by reviewdog 🐶

Suggested change

Copy link
Copy Markdown
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Great, thanks

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 6, 2025

Preview URLs

External URLs (1)

URL: /en-US/docs/Web/API/IDBObjectStore/openCursor
Title: IDBObjectStore: openCursor() method

@Josh-Cena Josh-Cena merged commit fdf0acb into mdn:main Apr 6, 2025
8 checks passed
wbamberg added a commit to wbamberg/content that referenced this pull request Apr 6, 2025
* upstream/main: (158 commits)
  fix: remove unrelated add() method reference from openCursor() doc (mdn#38998)
  Fix link (mdn#38995)
  Remove uncovered topic from a tuturial overview. (mdn#38999)
  Change the description of Temporal.Instant (mdn#38996)
  Remove `port` mention for URL `protocol` documentation (mdn#39000)
  Improve the clarity of a sentence (mdn#39003)
  Change if...else to non-zero on control_flow page (mdn#38992)
  Update group-data of EditContext API (mdn#38842)
  improve description (mdn#38845)
  fix: auto-cleanup by bot (mdn#38990)
  New pages: HTMLFormElement.rel and .relList (mdn#38900)
  Add live sample embeds for SVG path examples (mdn#38928)
  Remove uncovered topic from the introduction (mdn#38986)
  Remove self-links (mdn#38982)
  Synchronize with BCD v6.0.3 (mdn#38983)
  Fix grammar (mdn#38981)
  Remove external Web Speech API articles (mdn#38980)
  Add missing {{Specifications}} macros (mdn#38975)
  Remove browser-compat for CSS types without BCD (mdn#38970)
  Update async_function_star_ to have a working example (mdn#38972)
  ...
cssinate pushed a commit to cssinate/content that referenced this pull request Apr 11, 2025
…dn#38998)

* fix: remove unrelated add() method reference from openCursor() doc

* Update index.md

---------

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:WebAPI Web API docs size/xs [PR only] 0-5 LoC changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Second paragraph seems like from a different page

3 participants