Update interrupts.adoc #844
Conversation
I have proposed a change to the interrupts() page.
| @@ -17,7 +17,7 @@ subCategories: [ "Interrupts" ] | |||
|
|
|||
| [float] | |||
| === Description | |||
| Re-enables interrupts (after they've been disabled by link:../nointerrupts[noInterrupts()]. Interrupts allow certain important tasks to happen in the background and are enabled by default. Some functions will not work while interrupts are disabled, and incoming communication may be ignored. Interrupts can slightly disrupt the timing of code, however, and may be disabled for particularly critical sections of code. | |||
| Re-enables interrupts (after they've been disabled by link:../nointerrupts[noInterrupts()]. Interrupts allow certain important tasks to happen in the background and are enabled by default. Some functions will not work while interrupts are disabled, and incoming communication may be ignored. Interrupts can slightly disrupt the timing of code, however, and may be disabled for particularly critical sections of code. They can also cause races, code that behaves differently, and incorrectly, in response to tiny changes in timing. See `interrupts()` for further information. | |||
There was a problem hiding this comment.
Hi @MalcolmBoura. Thanks for taking the time to submit a pull request!
See
interrupts()for further information.
I don't understand this instruction to the reader. What do you mean by "see interrupts()"?
There was a problem hiding this comment.
Oops, sorry. Was meant to be a link to the attachInterrupt() page and the surrounding text could be clearer. I suggest:
See the link:../attachInterrupt[attachInterrupt()] page for further information.
I will see if I can add that to the branch but I have not used git or github much.
I have proposed an update to the attachInterrupt() page which explains the problem and how to fix it.
There was a problem hiding this comment.
I think this version of the link is more likely to work. I will read the documentation again as soon as I can.
See the link:../External%20Interrupts/attachInterrupt[attachInterrupt()] page for further information.
| @@ -17,10 +17,9 @@ subCategories: [ "Interrupts" ] | |||
|
|
|||
| [float] | |||
| === Description | |||
| Re-enables interrupts (after they've been disabled by link:../nointerrupts[noInterrupts()]. Interrupts allow certain important tasks to happen in the background and are enabled by default. Some functions will not work while interrupts are disabled, and incoming communication may be ignored. Interrupts can slightly disrupt the timing of code, however, and may be disabled for particularly critical sections of code. | |||
| Re-enables interrupts (after they've been disabled by link:../nointerrupts[noInterrupts()]. Interrupts allow certain important tasks to happen in the background and are enabled by default. Some functions will not work while interrupts are disabled, and incoming communication may be ignored. Interrupts can slightly disrupt the timing of code, however, and may be disabled for particularly critical sections of code. They can also cause races, code that behaves differently, and incorrectly, in response to tiny changes in timing. See the link:../External%20Interrupts/attachInterrupt[attachInterrupt()] page for further information. | |||
There was a problem hiding this comment.
| Re-enables interrupts (after they've been disabled by link:../nointerrupts[noInterrupts()]. Interrupts allow certain important tasks to happen in the background and are enabled by default. Some functions will not work while interrupts are disabled, and incoming communication may be ignored. Interrupts can slightly disrupt the timing of code, however, and may be disabled for particularly critical sections of code. They can also cause races, code that behaves differently, and incorrectly, in response to tiny changes in timing. See the link:../External%20Interrupts/attachInterrupt[attachInterrupt()] page for further information. | |
| Re-enables interrupts (after they've been disabled by link:../nointerrupts[noInterrupts()]. Interrupts allow certain important tasks to happen in the background and are enabled by default. Some functions will not work while interrupts are disabled, and incoming communication may be ignored. Interrupts can slightly disrupt the timing of code, however, and may be disabled for particularly critical sections of code. They can also cause races, code that behaves differently, and incorrectly, in response to tiny changes in timing. See the link:../../external-interrupts/attachinterrupt[attachInterrupt()] page for further information. |
Correct link.
Each file is converted to a folder on the website, so this requires an extra tree level in links when compared to the paths here in the repository.
All characters in the paths are lowercased on the website.
The website uses a hypen as a space replacement character (e.g., external-interrupts)
| [%hardbreaks] | ||
|
|
||
|
|
There was a problem hiding this comment.
Let's leave the line break here because it is unrelated to the proposal and this is the style established in the reference sample:
I have proposed changes to the noInterrupts() and interrupts() pages referring readers to this page.