nvda icon indicating copy to clipboard operation
nvda copied to clipboard

Published 20 hours ago • verified publisher icon nvaccess

Reference API mailing list and improve docs for deprecations

Open seanbudd opened this issue 1 year ago • 3 comments

Reference the new NVDA API announcements mailing list in the developer guide and the change log.

Adds notes to the developer guide on the NVDA deprecation, removal and addition process.

Updated the deprecations.md doc to include new deprecation processes.

After merging:

  • update https://github.com/nvaccess/nvda/wiki/deprecations to refer to built developer guide (eg html file hosted on NV Access website).

seanbudd avatar Aug 09 '22 07:08 seanbudd

I do not know if it is in the scope of this PR or not. But I have realized while translating the changes log for 2022.3 that we will end up for each release with the following paragraph:

These are proposed API breaking changes. The deprecated part of the API will continue to be available until the specified release. If no release is specified, the plan for removal has not been determined. Note, the roadmap for removals is 'best effort' and may be subject to change. Please test the new API and provide feedback. For add-on authors, please open a GitHub issue if these changes stop the API from meeting your needs.

Can we change the process to avoid repeating this information all along the change log?

  1. This would avoid redundancy in the log
  2. In case this paragraph changes just a bit, there is a chance that readers and/or translators do not notice that something has changed because the details of this paragraph will not be read anymore.

CyrilleB79 avatar Aug 09 '22 20:08 CyrilleB79

@CyrilleB79 - I think it could be considered in scope.

The large block of text could go inside the developerGuide instead. the change log does not need to contain this information.

seanbudd avatar Aug 10 '22 02:08 seanbudd

  • PASS: Translation comments check.
  • PASS: Unit tests.
  • PASS: Lint check.
  • FAIL: System tests. See test results for more information.
  • Build (for testing PR): https://ci.appveyor.com/api/buildjobs/hix3d2ixbng9j5r5/artifacts/output/nvda_snapshot_pr13999-26137,e704e084.exe

See test results for failed build of commit e704e084c5

AppVeyorBot avatar Aug 10 '22 08:08 AppVeyorBot

  • PASS: Translation comments check.
  • PASS: Unit tests.
  • PASS: Lint check.
  • FAIL: System tests. See test results for more information.
  • Build (for testing PR): https://ci.appveyor.com/api/buildjobs/whfaafp6qq6mr632/artifacts/output/nvda_snapshot_pr13999-26210,9f433ed7.exe

See test results for failed build of commit 9f433ed717

AppVeyorBot avatar Aug 17 '22 08:08 AppVeyorBot