Document incomplete nature of "p08_DigitalHourglass" #84
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
The sketches under the "10.StarterKit_BasicKit" folder are provided to accompany the Arduino Projects Book of the Arduino Starter Kit. The Arduino Projects Book explains the code of these sketches and gives instructions for their usage. In addition to owners of the Arduino Starter Kit, other users might use these prominent sketches as learning references. Those users won't have the context that would be provided by the Arduino Projects Book. For this reason, explanatory comments have been added to these sketches. The "p08_DigitalHourglass" is unique in that it is intentionally left incomplete. The Arduino Projects Book instructs the user to add their own code to indicate the completion of the timer. It is important that this code be added, since the incomplete code does not halt the LED control code at the end of the hour. If the incomplete code is used unchanged, the LED control code will call `digitalWrite` on additional pins. Previously, the comments in the sketch did not explain the incomplete nature of the sketch. Comments are hereby added to explain this to users who don't have the context provided by the Arduino Projects Book.
per1234
added
type: enhancement
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.
The sketches under the
10.StarterKit_BasicKitfolder are provided to accompany the Arduino Projects Book of the Arduino Starter Kit. The Arduino Projects Book explains the code of these sketches and gives instructions for their usage.In addition to owners of the Arduino Starter Kit, other users might use these prominent sketches as learning references. Those users won't have the context that would be provided by the Arduino Projects Book. For this reason, explanatory comments have been added to these sketches.
The "p08_DigitalHourglass" sketch is unique in that it is intentionally left incomplete. The Arduino Projects Book instructs the user to add their own code to indicate the completion of the timer. It is important that this code be added, since the incomplete code does not halt the LED control code at the end of the hour. If the incomplete code is used unchanged, the LED control code will call
digitalWriteon additional pins.Previously, the comments in the sketch did not explain the incomplete nature of the sketch. Comments are hereby added to explain this to users who don't have the context provided by the Arduino Projects Book.
Mitigates #83