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

Code structure: Clarify VirtualBuffers vs NVDAObjects #12676

Open
feerrenrut opened this issue Jul 23, 2021 · 1 comment
Open

Code structure: Clarify VirtualBuffers vs NVDAObjects #12676

feerrenrut opened this issue Jul 23, 2021 · 1 comment
Labels
audience/nvda-dev PR or issue is relevant to NVDA / Add-on developers p3 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority

Comments

@feerrenrut
Copy link
Contributor

Is your feature request related to a problem? Please describe.

As a developer understanding the structure and differences between classes in the virtualBuffers folder and the NVDAObjects/IAccessible/ folders is important. At the moment there seems to be some confusion about the locations of these clasess

Describe the solution you'd like

  • Add docs to help developers decide if the code they are adding belongs in one location or the other.
  • Move classes for virtualBuffers to new or existing modules in the virtualBuffers folder.

Describe alternatives you've considered

  • Leave the code as is

Additional context

  • Moving code will result in deprecations, and may not be possible in a backwards compatible way.
@feerrenrut feerrenrut added the audience/nvda-dev PR or issue is relevant to NVDA / Add-on developers label Jul 23, 2021
@feerrenrut feerrenrut added this to the 2022.1 milestone Jul 23, 2021
@seanbudd seanbudd added p3 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority api-breaking-change labels Jan 10, 2022
@feerrenrut
Copy link
Contributor Author

This could potentially be done without breaking the API by importing the moved module into the old package. This wouldn't hurt developer comprehension too much if it is enclosed in a deprecation condition and comment to explain the moved code.

@feerrenrut feerrenrut removed this from the 2022.1 milestone Feb 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
audience/nvda-dev PR or issue is relevant to NVDA / Add-on developers p3 https://github.com/nvaccess/nvda/blob/master/projectDocs/issues/triage.md#priority
Projects
None yet
Development

No branches or pull requests

2 participants