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(Client): remove missing options.maxShards option #82

Merged
merged 1 commit into from
Jul 9, 2023

Conversation

mistval
Copy link
Contributor

@mistval mistval commented Jul 9, 2023

I noticed the docs still show an options.maxShards option but it appears to not work. The comment correctly notes that This option has been moved under 'options.gateway'

I can only speculate but I suspect not marking it [DEPRECATED] here may have been a simple oversight in the original MR, which does however mark it deprecated in index.d.ts.

So I propose removing it to reduce potential confusion. I would also be up for making it work and adding a deprecation warning, but I see it looks like most of those have been ripped out from the dev branch.

@TTtie TTtie added the type: docs Improvements or additions to documentation label Jul 9, 2023
@TTtie TTtie added this to the 0.2.0 milestone Jul 9, 2023
Copy link
Member

@TTtie TTtie left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

As for the availability of options.maxShards, the docs for this should have been removed in 75d58b7 (hence it is also unavailable in 0.1.x), but thanks to the missing [DEPRECATED] marker, I probably overlooked it and forgot to remove it.

@TTtie TTtie changed the title Delete unused Client options.maxShards option from the jsdoc docs(Client): remove missing options.maxShards option Jul 9, 2023
@TTtie TTtie merged commit 08e8058 into projectdysnomia:dev Jul 9, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants