Documentation Typo Fixes for Motoko Base Library Design Guide #607
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.
Overview
This pull request addresses several typographical errors in the Motoko Base Library's design documentation. Ensuring accuracy and clarity in our documentation is vital for effective communication among developers and for maintaining the high standard of our project.
Changes Made
keys
iterator. This fix ensures that the documentation accurately represents the functionality of the iterator.put
method name overset
, especially in the context of sets and other containers.Impact
These changes, while minor, contribute to the overall readability and professionalism of our documentation. They do not affect the actual functionality of the codebase but are essential for consistent and error-free documentation.
Additional Notes
While reviewing the documentation, I've noticed a few areas where further clarification might be beneficial. I plan to propose additional updates in subsequent pull requests to continuously improve the documentation.