-
Notifications
You must be signed in to change notification settings - Fork 175
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
@category doc over class props, causes constructor to be categorized as "Other" #661
Labels
bug
Issue raised as a bug.
Comments
Thanks - will review and fix with next release. |
tgreyuk
added a commit
that referenced
this issue
Aug 5, 2024
tgreyuk
added a commit
that referenced
this issue
Aug 6, 2024
tgreyuk
added a commit
that referenced
this issue
Aug 8, 2024
Merged
Should be fixed in typedoc-plugin-markdown@4.2.4. |
It works, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What package is the bug related to?
typedoc-plugin-markdown
Describe the issue
This may not be a bug, per se, but the ergonomics of it feel a little off.
If the properties of a class have the
@category
tag, then theconstructor
is no longer given the heading "Constructors"; instead, it is under the heading "Other."One possible workaround is to give the
constructor
the@category
tag of@category Constructor
, but it will cause the "Constructor" heading to alphabetically come after other categories (e.g. "Color"). So this isn't a fix.See minimal example and run
npm run docs
, which also outputs the Typedoc json.The
animalWithoutCategories.ts
outputs theconstructor
under the right heading, andanimalWithCategories.ts
outputs theconstructor
under the heading of "Other".TypeDoc configuration
Expected behavior
I expect that the Constructor would retain it's own unique heading, and be at the top of the page under headings like "Implements", which is not affected by alphabetical ordering. I would expect this given the importance of a constructor in a class.
The text was updated successfully, but these errors were encountered: