Correct spelling and improve readability in documentation #10594
+3
−3
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.
Description:
This pull request addresses a couple of spelling and readability issues in the documentation files.
Changes made:
File:
docs/add-code-flow.md
Reason: The term "data structures" should be two words instead of a single word for better readability and consistency with common usage.
File:
docs/datastores.md
Reason: Corrected the typo in the word "availble" to "available" in the section discussing the "pebbleds" datastore.
These changes are important because they improve the clarity and correctness of the documentation. While "datastructures" is not technically wrong, separating it into "data structures" is the more widely accepted form and improves readability. Similarly, the typo in "availble" could cause confusion and looks unprofessional, so it was corrected to "available" to maintain accuracy.
Impact:
These corrections enhance the overall user experience by ensuring the documentation is clear, precise, and free from typographical errors.
Thank you for reviewing this update!