doc: Clarify constraints#47
Open
chrysn wants to merge 1 commit intorust-embedded-community:masterfrom
Open
Conversation
Member
|
Thank you! |
MathiasKoch
approved these changes
Jul 25, 2024
Collaborator
MathiasKoch
left a comment
There was a problem hiding this comment.
Not sure how I missed this even after being tagged. Sorry about that.
Looks great to me 👍
Could you add the same to async?
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
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 improves the documentation in a few places where I think it is lacking, in particular (sorted for expected most controversial to least controversial):
There is one change I'm tempted to make but I'm not sure what to change it to, i.e., what the intended behavior is:
On MultiwriteNorFlash, what happens if the application attempts to write something that does not have the bits cleared that are already cleared?
If this passes review, I'll copy the changes over to the async equivalents, which AIU have identical APIs.