• Before scrolling in browse mode, check if the caret is in the first line of the object to be placed
• Use Sphinx style to describe parameters
• Update changelog

Link to issue number:

Fixes #17669

Summary of the issue:

When anchor links point to the objec where the virtual caret is placed, NVDA doesn't scroll to the link destination.

Description of user facing changes

NVDA Will scroll to destination of anchor links, even where they point to the object where the virtual caret is placed.

Description of development approach

In the _handleScrollTo function of source/browseMode.py, we check if the caret is placed in the same line as the anchor link destination, instead of checking if it's in the same object.
This has been explained and suggested by @jcsteh in #17669.

Testing strategy: placed in the same object.

Tested with Firefox on Windows 11, and with Chrome and Edge, with and without UIA enabled, using the demo provided in #17669

Known issues with pull request:

None

Code Review Checklist:

• Documentation:
  • Change log entry
  • User Documentation
  • Developer / Technical Documentation
  • Context sensitive help for GUI changes
• Testing:
  • Unit tests
  • System (end to end) tests
  • Manual testing
• UX of all users considered:
  • Speech
  • Braille
  • Low Vision
  • Different web browsers
  • Localization in other languages / culture than English
• API is compatible with existing add-ons.
• Security precautions taken.

@coderabbitai summary