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

docs: fix various typos in documentation and comments #2424

Merged
merged 1 commit into from
Dec 20, 2024

Conversation

vblazenka
Copy link
Contributor

@vblazenka vblazenka commented Dec 19, 2024

Description

The goal of this PR was to improve readability and professionalism of the project documentation. There are still possible gramamr issues, etc but I was just focusing on misspelled words.

  • Fix "equiped" to "equipped" in waspc/README.md
  • Fix "thightened" to "tightened" in ChangeLog.md
  • Fix "improt" to "import" in ChangeLog.md
  • Fix "explicitely" to "explicitly" in README.md
  • Fix other minor spelling and grammar issues

image

Select what type of change this PR introduces:

  1. Just code/docs improvement (no functional change).
  2. Bug fix (non-breaking change which fixes an issue).
  3. New feature (non-breaking change which adds functionality).
  4. Breaking change (fix or feature that would cause existing functionality to not work as expected).

Update Waspc ChangeLog and version if needed

If you did a bug fix, new feature, or breaking change, that affects waspc, make sure you satisfy the following:

  1. I updated ChangeLog.md with description of the change this PR introduces.
  2. I bumped waspc version in waspc.cabal to reflect changes I introduced, with regards to the version of the latest wasp release, if the bump was needed.

Update example apps if needed

If you did code changes and added a new feature or modified an existing feature, make sure you satisfy the following:

  1. I updated waspc/examples/todoApp as needed (updated modified feature or added new feature) and manually checked it works correctly.
  2. I updated waspc/headless-test/examples/todoApp and its e2e tests as needed (updated modified feature and its tests or added new feature and new tests for it).

Copy link
Contributor

@infomiho infomiho left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sweet! Thanks for the typo fixes, it really is honest work.

One question, I noticed you fixed a lot of things in the versioned_docs folder, so I wanted to check with you if you maybe noticed the same typos in the docs folder? (docs folder is the "latest" version)

- Fix "equiped" to "equipped" in waspc/README.md
- Fix "thightened" to "tightened" in ChangeLog.md
- Fix "improt" to "import" in ChangeLog.md
- Fix "explicitely" to "explicitly" in README.md
- Fix other minor spelling and grammar issues

This commit improves readability and professionalism of the project documentation.
@vblazenka vblazenka force-pushed the fix/typo-fixes-in-docs branch from 9afbaeb to 619416a Compare December 19, 2024 11:51
@vblazenka
Copy link
Contributor Author

I've used global search and replace that is why files in versioned_docs were changed. I've found a few more when checking docs folder once again. But I would say that this is it for now. I can nitpick more but I can easily open a new PR.

@vblazenka
Copy link
Contributor Author

@infomiho feel free to merge it if you think it's good for now

@infomiho infomiho merged commit 4c2a935 into wasp-lang:main Dec 20, 2024
6 checks passed
@vblazenka vblazenka deleted the fix/typo-fixes-in-docs branch December 22, 2024 14:42
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.

2 participants