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

Fix: Typos corrected in comments and variables #472

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

qvkare
Copy link

@qvkare qvkare commented Dec 9, 2024

Why is this change needed?

This PR focuses on correcting typographical errors in variable names, comments, and documentation across several files to ensure clarity, accuracy, and a better developer experience.

Key Changes:

  • Fixed spelling errors in variable names, comments, and logs:
    • Updated "recieving" to "receiving" in multiple files.
    • Corrected "recieved" to "received" in log statements.
    • Fixed typo in "collectionAddres" → "collectionAddress" in premint-client.ts.
    • Added clear descriptions for the sparkValue function in typedData.ts.

Detailed Summary:

  1. IERC20Z.sol:

    • Corrected comment typo:
      • recievingreceiving.
  2. ZoraTimedSaleStrategyMarketTest.t.sol:

    • Fixed typo in a log statement:
      • "recieved eth""received eth".
  3. typedData.ts:

    • Added a detailed description for the sparkValue function to explain its purpose and return value.
  4. premint-client.ts:

    • Fixed typo in a key property:
      • "collectionAddres""collectionAddress".
  5. SponsoredSparksSpender.sol:

    • Corrected a comment typo:
      • recievingreceiving.

How has it been tested?

  • Verified the updates in comments and variable names for accuracy.
  • Reviewed log statements and documentation for improved clarity and consistency.
  • Confirmed that no functional changes were introduced during the typo fixes.

What tests did you add/modify to account for these changes?

The changes were tested by manually reviewing the updated files to ensure:

  • Typographical errors were corrected properly.
  • No unintended modifications were made.
  • All updated comments and logs convey the intended information accurately.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New module / feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I added a changeset to account for this change.

Reviewer Checklist:

  • My review includes a synopsis of the changes and potential issues.
  • The code style is enforced.
  • There are no risky / concerning changes / additions to the PR.

@qvkare
Copy link
Author

qvkare commented Dec 12, 2024

Hey @oveddan @iainnash can you check?

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.

5 participants