-
Notifications
You must be signed in to change notification settings - Fork 182
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
bug: descriptions are being dropped for "other" category symbols #664
Comments
Thanks - have a fix and it will go into the next release. |
Should be fixed in typedoc-plugin-markdown@4.2.4 . |
Alas it appears that this is not yet fully fixed. I am definitely on the right version: But the generated markdown only has doc comments for the ---
editUrl: false
next: true
prev: true
title: DiscordMessage
---
## Extends
- `LitElement`
## Implements
- [`LightTheme`](/api/interfaces/lighttheme/)
## Constructors
### new DiscordMessage()
> **new DiscordMessage**(): [`DiscordMessage`](/api/classes/discordmessage/)
#### Returns
[`DiscordMessage`](/api/classes/discordmessage/)
#### Inherited from
`LitElement.constructor`
## Accessors
### author
The message author's username.
#### Default Value
\```ts
'User'
\```
***
### avatar
***
### bot
***
### compactMode
***
### dismissMessageClicked
***
### edited
***
### ephemeral
***
### hasThread
***
### highlight
***
### lightTheme
#### Implementation of
[`LightTheme`](/api/interfaces/lighttheme/).[`lightTheme`](/api/interfaces/lighttheme/#lighttheme)
***
### messageBodyOnly
***
### noBackground
***
### op
***
### profile
***
### roleColor
***
### roleIcon
***
### roleName
***
### server
***
### timestamp
***
### twentyFour
***
### verified
I have updated the |
@favna apologies. It really should be fixed in 4.2.5: ![]() |
Confirmed! Tyvm!! |
What package is the bug related to?
typedoc-plugin-markdown
Describe the issue
Note
I first reported this for starlight-typedoc, however this appears to be an issue with the underlying typedoc-plugin-markdown instead. See: HiDeoo/starlight-typedoc#55
For the project https://github.com/skyra-project/discord-components I use
public accessor
because that's how Lit Element works when using TC39 decorators. When parsing this with regular typedoc (config below) the accessor still do get put into the "other" category just like typedoc-plugin-markdown does, however unlike typedoc-plugin-markdown, regular typedoc still retains descriptions.Relevant code: https://github.com/skyra-project/discord-components/blob/e34e27efff4d1fb3d41def616bed017d97964d34/packages/core/src/components/discord-audio-attachment/DiscordAudioAttachment.ts#L124-L169
From the HTML generated by Typedoc:
![ishare-1722689243](https://private-user-images.githubusercontent.com/4019718/354817495-8e1f7624-f6f9-4a29-965f-7546116fda76.PNG?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkwNzAyNTgsIm5iZiI6MTczOTA2OTk1OCwicGF0aCI6Ii80MDE5NzE4LzM1NDgxNzQ5NS04ZTFmNzYyNC1mNmY5LTRhMjktOTY1Zi03NTQ2MTE2ZmRhNzYuUE5HP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIwOSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMDlUMDI1OTE4WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9M2RmMjMzZTVkNjY3MTI0YWNkOTFjMzU1MDIwN2Q5ZWY1OTNmOWI5ODk4MDQ0MTQzMmIzODFhMTRmMmY2MGUwMCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.EUXt5UhZzE4IeyTbfdYZPkATRIJmYwtCuMFPsDZdoLI)
From the HTML generated by starlight-typedoc (which uses typedoc-plugin-markdown):
To Reproduce
git switch bugreport/starlight-typedoc-other-descriptions
to switch to a branch with some files prepared for this bug reportyarn install --immutable
yarn build
yarn bug:starlight
yarn bug:typedoc
, this will build with regular typedoc and start an HTTP server on port 8090TypeDoc configuration
Expected behavior
The tsdoc comments from accessors (other category symbols) aren't dropped
System Info
The text was updated successfully, but these errors were encountered: