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 API naming #2212

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

Conversation

gekkedev
Copy link
Contributor

@gekkedev gekkedev commented Jun 11, 2024

  • stopRecoring -> stopRecording
  • GroupNotificationType.Inivite -> GroupNotificationType.Invite
  • a little bit of spelling/grammar changes

This change might make a lot of code incompatible, so maybe it is better to save this for the next major release?

Before merging; I think I found one more potential typo:
https://github.com/gekkedev/wppconnect/blob/76baaca6fcb824b26f94a12339c3fda0ef7d5129/src/api/layers/sender.layer.ts#L145
Should be "error" in my opinion, but: Is this key from the platform or is it created by WPPC?

@gekkedev gekkedev changed the title fix: typo in an API method name fix: typos in APIs Jun 12, 2024
@gekkedev gekkedev changed the title fix: typos in APIs fix: typos in API naming Jun 12, 2024
@gekkedev gekkedev marked this pull request as ready for review June 12, 2024 14:17
@icleitoncosta
Copy link
Contributor

So, since the function name is already incorrect, we cannot change it because it will break the current users. In this case, we have to leave it as it is until we release a more comprehensive breaking change.

@gekkedev
Copy link
Contributor Author

what if I prepare a deprecation instead so that no one else starts using the methods/enums with typos and uses the correct name?

  1. rename the function/enum to have the correct name
  2. create an alias that refers to the correct name and add the @deprecated flag

@gekkedev gekkedev changed the title fix: typos in API naming fix!: typos in API naming Aug 28, 2024
Copy link

@manfe manfe left a comment

Choose a reason for hiding this comment

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

LGTM, enum is not even being used.

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.

3 participants