Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct spelling and improve readability in documentation #10594

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

famouswizard
Copy link

Description:

This pull request addresses a couple of spelling and readability issues in the documentation files.

Changes made:

  1. File: docs/add-code-flow.md

    • Change: "datastructures" → "data structures"
      Reason: The term "data structures" should be two words instead of a single word for better readability and consistency with common usage.
  2. File: docs/datastores.md

    • Change: "availble" → "available"
      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!

@famouswizard famouswizard requested a review from a team as a code owner November 21, 2024 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant