discordjs / discordjs/website

Various `|` (or) returns do not display correctly on the documentation

Open
#146 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Vue
Stars
187
Forks
109
PR merge metrics
No merged PRs in 30d

Description

### Which package is this bug report for?

discord.js

### Issue description

At:
- [`CommandInteractionOptionResolver#getChannel()`](https://discord.js.org/#/docs/discord.js/main/class/CommandInteractionOptionResolver?scrollTo=getChannel)
- [`GuildChannelManager#resolve()`](https://discord.js.org/#/docs/discord.js/main/class/GuildChannelManager?scrollTo=resolve)
- [`CommandInteractionOptionResolver#getMentionable()`](https://discord.js.org/#/docs/discord.js/main/class/CommandInteractionOptionResolver?scrollTo=getMentionable)

The `Returns` element does not resolve to a proper `Foo|Bar` format, instead resorting to `FooBar` (links do work as expected).
I was not able to find any more of these but there is a big chance there are more than just these 3.

https://github.com/discordjs/discord.js/blob/950fc47234ed7702a20c90246823a5215c75e84f/packages/discord.js/src/structures/CommandInteractionOptionResolver.js#L146

https://github.com/discordjs/discord.js/blob/950fc47234ed7702a20c90246823a5215c75e84f/packages/discord.js/src/managers/GuildChannelManager.js#L84

https://github.com/discordjs/discord.js/blob/950fc47234ed7702a20c90246823a5215c75e84f/packages/discord.js/src/structures/CommandInteractionOptionResolver.js#L261

Example:
Schermafbeelding 2023-03-21 om 20 53 15

### Code sample

_No response_

### Package version

Does not apply

### Node.js version

Does not apply

### Operating system

Chrome 111.0.5563.64, also tested on Safari 14.1.2

### Priority this issue should have

Low (slightly annoying)

### Which partials do you have configured?

Not applicable (subpackage bug)

### Which gateway intents are you subscribing to?

Not applicable (subpackage bug)

### I have tested this issue on a development release

_No response_

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the linked CommandInteractionOptionResolver.js and GuildChannelManager.js locations, then inspect how their Returns types are rendered in the documentation pages. Check whether the documentation generator or renderer drops the union separator, and verify that the listed return types display as Foo|Bar rather than FooBar.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.