Fix misleading log message for aria-current="true"#11782
Merged
Conversation
Types and naming for isCurrent were confusing, so normalize the types using an enum and only name as ariaCurrent when the data is specific to aria-current, otherwise use 'isCurrent'. Include comments to link aria-current as the potential (likely) source for 'isCurrent'
This comment has been minimized.
This comment has been minimized.
LeonarddeR
previously approved these changes
Nov 20, 2020
feerrenrut
commented
Nov 24, 2020
LeonarddeR
previously approved these changes
Nov 24, 2020
LeonarddeR
reviewed
Dec 9, 2020
- Use a property - shorten name
Contributor
Author
|
@LeonarddeR I have addressed your suggestions. I think making this a property is a good idea. I decided against |
LeonarddeR
reviewed
Dec 31, 2020
Contributor
Author
|
I have just noticed inconsistent case for |
Contributor
Author
|
Python docs for enum use upper case for members of the enum, so I'll match that style. |
See test results for failed build of commit afe27d9a62 |
michaelDCurran
previously approved these changes
Jan 25, 2021
See test results for failed build of commit 66cf02e9be |
AAClause
added a commit
to AAClause/BrailleExtender
that referenced
this pull request
Feb 7, 2021
This was referenced May 14, 2021
feerrenrut
pushed a commit
that referenced
this pull request
May 21, 2021
Changes from #11782 were listed twice, though slightly differently. Picked the best lines from both.
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
4 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:
None
Summary of the issue:
There is a misleading log message for aria-current="true". It was a non-handled value, an exception was raised, a message added to the log, and the value
True(bool rather than str) was used.When trying to follow this code it is hard to know where the values are strings, None, or bool. In some cases the naming is overly specific.
Description of how this pull request fixes the issue:
Types and naming for isCurrent were confusing, so normalize the types
using an enum and only name as ariaCurrent when the data is specific to aria-current,
otherwise use 'isCurrent'. Include comments to link aria-current as the
potential (likely) source for 'isCurrent'
Testing performed:
Used Chrome, Firefox, IE, and Edge with https://a11ysupport.io/tests/html/aria/aria-current.html
Known issues with pull request:
This is technically an API breaking change. If there are any concerns about this, we may have to wait for the 2021.1 release.
Change log entry: