Skip to content
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

Duplicate tags on function parameters #2385

Closed
RunDevelopment opened this issue Sep 2, 2023 · 1 comment
Closed

Duplicate tags on function parameters #2385

RunDevelopment opened this issue Sep 2, 2023 · 1 comment
Labels
bug Functionality does not match expectation

Comments

@RunDevelopment
Copy link
Contributor

Search terms

class, function, method, tag, optional, rest

Expected Behavior

Function parameters have tags such as "Optional" and "Rest" that describe their function. These tags should only appear once

Actual Behavior

The tags appear twice.

image
image
image

Obviously, this looks quite silly.

Steps to reproduce the bug

This should be fairly easy to reproduce. I have a very basic typedoc setup (typedoc.json).

In case you need a project, use refa. Just install the latest typedoc version, and npm run build:docs, and you'll be able to reproduce the issue. The above screenshot are from docs/interfaces/ReadonlyDFA.html#copy, docs/functions/transform.html, and docs/classes/CharSet.html#union.

Environment

  • Typedoc version: 0.25.0
  • TypeScript version: 5.0.1
  • Node.js version: v20.5.1
  • OS: Win 10

Side note

I also noticed that function parameters with a default value do not have the "Optional" tag. Is that intentional?

image

@RunDevelopment RunDevelopment added the bug Functionality does not match expectation label Sep 2, 2023
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Sep 3, 2023

Oops, introduced in c75e011

@Gerrit0 Gerrit0 closed this as completed in aefeac0 Sep 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants