question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Upgrade to v0.23 removes comments from re-exported methods

See original GitHub issue

Search terms

exports comments

Expected Behavior

I want TypeDoc to use the comments for where the file is defined as it was in version 0.22.x. Did I miss anything in the changelog? I couldn’t find a change that would affect this.

Actual Behavior

fileA.ts

/** A comment for a method */
export function myMethod() { /* ... */ }

index.ts

export { myMethod } from './fileA.ts';

The A comment for a method comment is not shown anymore in the docs.

Steps to reproduce the bug

See the example above.

Environment

  • Typedoc version: 0.23.2
  • TypeScript version: 4.7.4
  • Node.js version: 16.15.0
  • OS: Linux

Issue Analytics

  • State:closed
  • Created a year ago
  • Comments:7

github_iconTop GitHub Comments

1reaction
Gerrit0commented, Jun 28, 2022

Nope, you didn’t miss anything. This should still work. I’ll take a look tonight.

0reactions
chmaniecommented, Jul 5, 2022

Yep, this version fixes all my issues. Thank you so much for the quick response!

Read more comments on GitHub >

github_iconTop Results From Across the Web

Changelog | TypeDoc
Plugins should update to use the method on Converter . DefaultThemeRenderContext.attemptExternalResolution has also been deprecated since it will repeat ...
Read more >
ViewPropTypes has been removed from React Native. Migrate ...
Migrate to ViewPropTypes exported from 'deprecated-react-native-prop-types'. ERROR Invariant Violation: Module AppRegistry is not a registered ...
Read more >
MIXO:VERSIONS - The DJ Library
v0.54. 23rd August, 2022. [Fixed] Cues removed during analysis (XML, NML and RB6 imports) ... [Fixed] XML/NML imports break if tracks have long...
Read more >
Changelog - pydantic
Breaking Change, remove old deprecation aliases from v1, #2415 by @samuelcolvin: · Breaking Change: always validate only first sublevel items with each_item ....
Read more >
7 Release Notes | _main - IQR Tools - IntiQuan
Updated IQRnlmeProject covariate assessment functionality ... Fixed “M4” method handling for MONOLIX when LIMIT column not available; Remove “Baseline” from ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found