Documentation updates and cleanup #148
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
geomatsi
approved these changes
Dec 3, 2019
src/pwm.rs
Outdated
|
|
||
| // Set up the timer as a PWM output. Since there are multiple remap | ||
| // options for tim2 that use the same pins, you need to specify | ||
| // the remap generic parameter. |
There was a problem hiding this comment.
cc: @burrbull
In fact, this is not exactly so. It is possible to omit remap generic parameter in many cases when compiler is able to deduce mapping from the selected pins. It can be skipped on the first attempt and compiler will complain if it can not figure out the specific pin combination :)
How about updating this section, e.g. something along the following lines:
Set up the timer as a PWM output. If selected pins may correspond to different remap options,
then you shall specify the remap generic parameter. Otherwise, if there is no such ambiguity,
the remap generic parameter can be omitted without complains from the compiler.
There was a problem hiding this comment.
Yea, that's what I meant to say but I agree it's pretty unclear. Your wording is a lot better :)
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.
This fixes #144, both in terms of making that example compile without extra features, and documenting the features.
While i'm at it, I also updated the PWM and timer docs, and cleaned up
Cargo.toml