cleaned up PWM rustdoc #523
Open
Conversation
This file contains hidden or 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
|
Issue #524 addresses future work. |
qwandor
reviewed
Jun 24, 2025
| /// | ||
| /// Subsequent use of `set_duty_on_common()`, | ||
| /// `set_duty_on_group()`, *etc* will override this duty | ||
| /// cycle setting. |
There was a problem hiding this comment.
What duty cycle setting? Isn't this setting the frequency rather than the duty cycle?
qwandor
reviewed
Jun 24, 2025
| /// Cofigures how a sequence is read from RAM and is spread to the compare register. | ||
| /// Configures how a sequence is read from RAM and is | ||
| /// spread to the compare register. Disables | ||
| /// [Channel::C3] for [LoadMode::Waveform], and disables |
There was a problem hiding this comment.
I think you mean "enables it otherwise", though I'm not sure why.
There was a problem hiding this comment.
Correct. I'm not sure why either — seems like just a bug, but wanted to document current behavior before thinking about it.
|
Thanks for the review and the catches! I have a couple of other things to document as well at this point: I'll push an update RSN. |
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 PWM naming and usage is pretty confusing, and the Rustdoc does not clarify it. This is a bunch of doc changes to try to triage the situation. Should file an issue to maybe change the API, although at this late date not so likely probably.