Remove confusing and redundant wording #519
Merged
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
Member
tobiasvl
commented
Dec 14, 2023
tobiasvl
commented
- Remove confusing wording that seemed to imply that timer interrupts are executed immediately (regardless of priority)
- Remove redundant information about the IF register, which is not present in the descriptions of other interrupts
ISSOtm
reviewed
Dec 14, 2023
src/Interrupt_Sources.md
Outdated
| an interrupt is requested by setting bit 2 in the IF register | ||
| ($FF0F). As soon as that interrupt is enabled, the CPU will execute it by | ||
| calling the timer interrupt vector at $0050. | ||
| The timer interrupt is requested every time that the timer overflows |
There was a problem hiding this comment.
I think making the words "is requested" into a link to either IF's documentation or a more general description of the IRQ process (is there one?) would be appropriate in fulfilling the role that the rightfully removed text was. What do you say?
|
Then maybe the link should be added to every mention of an interrupt being requested? It seems a bit arbitrary to explain what it means for a timer interrupt to be requested, when the VBlank and STAT interrupts have already been discussed above with no explanation of what an IRQ entails. |
|
Oh, yes, sure! I only focused on the PR's changes, but if you think the change should be made elsewhere as well, then by all means go ahead! |
avivace
approved these changes
Jan 2, 2024
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.