bug: descriptions are being dropped for "other" category symbols
Closed this issue · 1 comments
Describe the bug
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 starlight-typedoc does, however unlike starlight-typedoc, regular typedoc still retains descriptions.
From the HTML generated by Typedoc:
From the HTML generated by starlight-typedoc:
The typedoc config used for the typedoc HTML (at path packages/core/typedoc.json
):
{
"readme": "../documentation/src/assets/README.md",
"excludeExternals": true,
"githubPages": true,
"disableSources": true,
"entryPoints": ["./src/index.ts"],
"tsconfig": "./src/tsconfig.json",
"basePath": "/",
"out": "./docs",
"cleanOutputDir": true
}
To Reproduce
- Clone https://github.com/skyra-project/discord-components
- Run
git switch bugreport/starlight-typedoc-other-descriptions
to switch to a branch with some files prepared for this bug report - Run
yarn install --immutable
- Run
yarn build
- Run
yarn bug:starlight
- Navigate to http://localhost:4321/api/classes/discordaudioattachment/#bytes
- In a new terminal run
yarn bug:typedoc
, this will build with regular typedoc and start an HTTP server on port 8090 - Navigate to http://localhost:8090/classes/DiscordAudioAttachment.html#bytes
Expected behavior
The tsdoc comments from accessors (other category symbols) aren't dropped
How often does this bug happen?
Every time
System Info
System:
OS: macOS 14.5
CPU: (8) arm64 Apple M1
Memory: 70.73 MB / 16.00 GB
Shell: 5.9 - /bin/zsh
Binaries:
Node: 22.4.0 - /private/var/folders/jy/w45_1th97698mzgm_nsfl35w0000gn/T/xfs-2eeb1fb6/node
Yarn: 4.3.1 - /private/var/folders/jy/w45_1th97698mzgm_nsfl35w0000gn/T/xfs-2eeb1fb6/yarn
npm: 10.8.1 - ~/.volta/tools/image/node/22.4.0/bin/npm
pnpm: 9.6.0 - ~/.volta/bin/pnpm
bun: 1.1.21 - /opt/homebrew/bin/bun
Browsers:
Edge: 127.0.2651.86
Safari: 17.5
Packages:
@astrojs/lit: ^4.3.0,
@astrojs/starlight: 0.25.3,
astro: 4.12.3,
starlight-typedoc: 0.13.1,
typedoc: 0.26.5,
typedoc-plugin-markdown: 4.2.3
Additional Context
I am not sure if this is a problem with typedoc-plugin-markdown or with starlight-typedoc. In case it's with typedoc-plugin-markdown I will create an issue there, so please let me know.
I am not sure if this is a problem with typedoc-plugin-markdown or with starlight-typedoc. In case it's with typedoc-plugin-markdown I will create an issue there, so please let me know.
To test this, I manually installed typedoc-plugin-markdown
to the core package and added the plugin to the packages/core/typedoc.json
file:
{
"readme": "../documentation/src/assets/README.md",
"excludeExternals": true,
"githubPages": true,
"disableSources": true,
"entryPoints": ["./src/index.ts"],
"tsconfig": "./src/tsconfig.json",
"basePath": "/",
"out": "./docs",
- "cleanOutputDir": true
+ "cleanOutputDir": true,
+ "plugin": ["typedoc-plugin-markdown"]
}
When running yarn bug:typedoc
(so no starlight-typedoc
), for the DiscordAudioAttachment
class, I get the same output:
***
### bytes
***
### bytesUnit
***
### href
***
I think this hints that the problem may be with typedoc-plugin-markdown
and not with starlight-typedoc
in this specific case.