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: remove unused Locale typedef #10191

Merged
merged 2 commits into from
Apr 4, 2024

Conversation

N1ckPro
Copy link
Contributor

@N1ckPro N1ckPro commented Mar 24, 2024

Please describe the changes this PR makes and why it should be merged:
Removes the unused typedef, as requested in the reviews

Status and versioning classification:

  • This PR only includes non-code changes, like changes to documentation, README, etc.

@N1ckPro N1ckPro requested a review from a team as a code owner March 24, 2024 11:19
Copy link

vercel bot commented Mar 24, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
discord-js ⬜️ Ignored (Inspect) Visit Preview Apr 4, 2024 7:30pm
discord-js-guide ⬜️ Ignored (Inspect) Visit Preview Apr 4, 2024 7:30pm

@Jiralite
Copy link
Member

Shouldn't this be removed @Qjuh?

@Qjuh
Copy link
Contributor

Qjuh commented Mar 24, 2024

Why should that be removed? As long as mainlib discord.js is JavaScript it should have JSDoc for intellisense purposes of non-ts users.

@Qjuh
Copy link
Contributor

Qjuh commented Mar 25, 2024

Oh wait, now I see. Yes, that should be removed, because we reference the external discord-api-types/v10 Locale in

/**
* @external Locale
* @see {@link https://discord-api-types.dev/api/discord-api-types-rest/common/enum/Locale}
*/
for documentation purposes. My bad

kyranet
kyranet previously requested changes Apr 2, 2024
Copy link
Member

@kyranet kyranet left a comment

Choose a reason for hiding this comment

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

Sorry, I didn't read the conversation first. Yes, the list should be removed, the typedef is already defined and links to discord-api-types's docs which is up-to-date.

@N1ckPro N1ckPro changed the title docs: add missing locales docs: remove unused Locale typedef Apr 4, 2024
@N1ckPro
Copy link
Contributor Author

N1ckPro commented Apr 4, 2024

I've updated the PR to remove the typedef instead as you suggested

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants