RPC icon indicating copy to clipboard operation
RPC copied to clipboard

Published 20 hours ago • verified publisher icon discordjs

docs: improve documentation

Open NotSugden opened this issue 4 years ago • 5 comments

This PR adds some better documentation, corrects some invalid syntax in the JSDoc comments, and deprecates RPCClient#sendJoinRequest as the command has been removed

this PR only changes documentation

reference: this pr is apart of the chain of prs requested from https://github.com/discordjs/RPC/pull/89#issuecomment-693537755

NotSugden avatar Sep 16 '20 20:09 NotSugden

Updated to requested changes, however there is just a nit - the VoiceSettings and UserVoiceSettings typedefs have properties marked as optional (for editing via any of the respective set* methods), but the same type is used as the return type - this would be incorrect as the properties will not be optional, not really sure of the best way to go about that or if it should even be addressed

NotSugden avatar Sep 17 '20 07:09 NotSugden

Shouldn't Promise<undefined> be changed to Promise<void>?

papaia avatar Sep 17 '20 07:09 papaia

Shouldn't Promise<undefined> be changed to Promise<void>?

thats what i thought, but https://github.com/discordjs/RPC/pull/90#discussion_r489948941

NotSugden avatar Sep 17 '20 07:09 NotSugden

Could throw in an index.d.ts while you're at it.

dscalzi avatar Sep 21 '20 14:09 dscalzi

Could throw in an index.d.ts while you're at it.

see https://github.com/discordjs/RPC/pull/89#issuecomment-693537755 snek doesn't want typings in the library itself

NotSugden avatar Sep 21 '20 14:09 NotSugden