Create documentation/aria-idl.md #2340
Open
Conversation
This file contains 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
✅ Deploy Preview for wai-aria ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
keithamus
approved these changes
Oct 11, 2024
| - ***Standardization***: Web APIs (e.g., `getAttribute()`) are implemented the same which ensures consistent behavior and usage across browsers | ||
| - ***Language-independent***: | ||
| - Define interfaces in a way that isn’t tied to a programming language, e.g., could have JavaScript/C++/Python or any other language implementation | ||
| - Easier to generate bindings (single web IDL spec can be used to generate bindings for multiple languages) |
There was a problem hiding this comment.
I think this sentence could read a little easier? Maybe this is an improvement:
Suggested change
| - Easier to generate bindings (single web IDL spec can be used to generate bindings for multiple languages) | |
| - Can be used to generate code (IDL files can be used to generate code across multiple languages) |
| - Define interfaces in a way that isn’t tied to a programming language, e.g., could have JavaScript/C++/Python or any other language implementation | ||
| - Easier to generate bindings (single web IDL spec can be used to generate bindings for multiple languages) | ||
| - Facilitates cross-language integration (e.g., Python backend can communicate with JavaScript frontend) | ||
| - ***Feature detection***: If (el.someIDLAttribute) is true, then the feature is supported which facilitates user agent detection for that particular attribute |
There was a problem hiding this comment.
Suggested change
| - ***Feature detection***: If (el.someIDLAttribute) is true, then the feature is supported which facilitates user agent detection for that particular attribute | |
| - ***Feature detection***: If (`'someIDLAttribute' in el`) is `true`, then the feature is supported; facilitating user agent detection for that particular attributes |
| - ***Documentation***: | ||
| - Specifies how web APIs should behave for both browser implementers and developers | ||
| - Interfaces are largely self documenting | ||
| - ***Backwards compatibility***: Can add new properties/methods without breaking backwards-compatibility |
There was a problem hiding this comment.
Perhaps worth capturing the consistency between APIs as a feature of IDL:
Suggested change
| - ***Backwards compatibility***: Can add new properties/methods without breaking backwards-compatibility | |
| - ***Backwards compatibility***: Can add new properties/methods without breaking backwards-compatibility | |
| - ***Consistency***: New APIs, such as methods and properties, follow similar forms to existing APIs - conventions and types are heavily reused, creating familiarity interface between APIs. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #2310
This PR adds a new
aria-idl.mddocumentation file that provides general explanation about IDL, how ARIA IDL works and chronology/history of key ARIA IDL decisions.