Add Feature Documentation #154
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
|
alright, it looks good from my perspective, however there's one more thing that could be done if you want. |
ferdnyc
reviewed
Sep 15, 2024
| - [ ] Find the AT-SPI event that corresponds to the desired feature | ||
| - Take a look at the docs for `common/events/` and try to find the right event. | ||
| - For example, to create a feature that reads out changed text in an aria-live region, you would want the event `TextChangedEvent`. | ||
| - [ ] Decide if there are any pre-requisites to the feature being triggerwd (think: focused window only, open tab only, etc.) |
There was a problem hiding this comment.
Suggested change
| - [ ] Decide if there are any pre-requisites to the feature being triggerwd (think: focused window only, open tab only, etc.) | |
| - [ ] Decide if there are any prerequisites to the feature being triggered (think: focused window only, open tab only, etc.) |
Spelling, consistency
| - [ ] Decide what, if any, state is required for your feature (caret position, last focused item, etc.) | ||
| - For example: to know if the current window is focused, the current window must be stored in the state of the screen reader. | ||
| - [ ] Check to see if we already have your state info as a type; you can check this at `odilia/src/state.rs`. | ||
| - If not, make a [newtype](https://doc.rust-lang.org/book/ch19-04-advanced-types.html#using-the-newtype-pattern-for-type-safety-and-abstraction), add it to the `State` struct, then implement the `FromAsyncState` trait for the type (so it can be extracted by the `FromAsyncState` implementation). |
There was a problem hiding this comment.
I wonder if it wouldn't be better, from a document-source-reading perspective, if this URL were a named reference? You'd change the link here to something like,
[newtype][newtype-pat]And waay at the bottom of the file, drop in:
[newtype-pat]: https://doc.rust-lang.org/book/ch19-04-advanced-types.html#using-the-newtype-pattern-for-type-safety-and-abstraction
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.
Fix #153