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 in documentation files #2661

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

Conversation

kilavvy
Copy link

@kilavvy kilavvy commented Feb 2, 2025

Description of Changes

Corrections have been made to the documentation regarding the operation of the AutoQueue and RampQueue classes. Typos have been fixed, and wording has been clarified to enhance understanding.

Fixed:

  • The description in the autoQueue.spec.ts tests has been updated to clarify that AutoQueue processes asynchronous functions in the order they are added.
  • The descriptions in autoQueue.ts and rampQueue.ts have been updated to reflect the correct usage of terms and improve comprehension.

Motivation and Context:
Clarifying the documentation will help developers better understand how queues work and their behavior when processing asynchronous functions. This is especially important for new contributors to the project and users of the library.

Dependencies:
No additional dependencies are required for this change.

Fixes # (issue number)

Type of Change

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

Checklist

  • I have tested my changes locally
  • I have performed a self-review of my changes
  • Updated any relevant documentation
  • Linked to any relevant issues
  • I have added tests relevant to my changes
  • Any dependent changes have been merged and published in downstream modules
  • My code is up to date with the base branch
  • I have updated relevant changelogs.

Copy link
Collaborator

@stwiname stwiname left a comment

Choose a reason for hiding this comment

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

Please follow the PR template

@kilavvy kilavvy requested a review from stwiname February 2, 2025 23:27
Copy link
Collaborator

@stwiname stwiname left a comment

Choose a reason for hiding this comment

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

I have updated relevant changelogs.

This has not been done

@kilavvy kilavvy requested a review from stwiname February 3, 2025 07:53
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