Skip to content

Conversation

Jiralite
Copy link
Member

Please describe the changes this PR makes and why it should be merged:
The events in the @links didn't actually exist, but now they do!

One cannot do {@link Client#shardReady} as this would redirect to the method which doesn't exist. Prefixing event: to this will redirect to the correct area (the event). This will require discordjs/website#104 to be merged as this is new parsing.

Status and versioning classification:

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

@ImRodry
Copy link
Contributor

ImRodry commented Sep 15, 2021

Don’t you need to change @emits tags too or will those be automatically fixed with the other PR?

@Jiralite
Copy link
Member Author

Jiralite commented Sep 15, 2021

Don’t you need to change @emits tags too or will those be automatically fixed with the other PR?

@emits tags are for event emitters, so by default, I made them reference only events. This means you don't have to do @emits Client#event:shardReady, you can simply do @emits Client#shardReady. The redirection of these will be fixed with the new parsing!

@iCrawl iCrawl merged commit b9a4899 into discordjs:main Sep 23, 2021
@Jiralite Jiralite deleted the shard-event branch September 23, 2021 11:47
@Jiralite Jiralite restored the shard-event branch September 27, 2021 09:50
@Jiralite Jiralite deleted the shard-event branch September 27, 2021 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants