Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update interrupts.adoc #844

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update interrupts.adoc #844

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
635df69
Update interrupts.adoc
MalcolmBoura Jul 27, 2021
c2e6669
Update interrupts.adoc
MalcolmBoura Jul 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Language/Functions/Interrupts/interrupts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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()"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

[%hardbreaks]


Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's leave the line break here because it is unrelated to the proposal and this is the style established in the reference sample:

https://raw.githubusercontent.com/arduino/reference-en/master/AsciiDoc_sample/Reference_Terms/AsciiDoc_Template-Single_Entity.adoc

Expand Down