Add notes on limitations to retaining backwards compatibility#14049
Merged
Conversation
6 tasks
6 tasks
feerrenrut
approved these changes
Aug 25, 2022
seanbudd
added a commit
that referenced
this pull request
Aug 30, 2022
Supersedes #14037 See also #14049 Summary of the issue: #14037 was closed because there was no way to preserve backwards compatibility. This is the case for any module level variable which the NVDA API expects to support assignment (see also #14049). globalVars contains many NVDA state variables which should not be changed by add-on authors. As a result, globalVars should eventually be deprecated, in favour of encapsulation of these variables. This will make retaining backwards compatibility possible in the future. Description of user facing changes None Description of development approach Added a deprecation warning and strategy to the docstring of globalVars. Encapsulated some less used globalVars to provide an example of what the future API should look like. runningAsSource was moved from globalVars as this is an unreleased variable. (#14015) _allowDeprecatedAPI was moved as it is internal code.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Link to issue number:
See also #14050
Summary of the issue:
#14037 was closed because there was no way to preserve backwards compatibility.
This is the case for any module level variable which the NVDA API expects to support assignment.
Description of user facing changes
None
Description of development approach
Documentation has been added:
Testing strategy:
N/A
Known issues with pull request:
N/A
Change log entries:
N/A
Code Review Checklist: