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

fix: export transiently referenced types #2717

Merged
merged 2 commits into from
Sep 24, 2024
Merged

Conversation

achingbrain
Copy link
Member

When we export a function like:

export function (foo: Bar): Baz {
  return { ... }
}

We have to also export the Bar type and any types it references, otherwise typedoc cannot create the API docs for us.

Also swaps instances of (default: foo) to use @default jsdoc tags.

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation if necessary (this includes comments as well)
  • I have added tests that prove my fix is effective or that my feature works

When we export a function like:

```ts
export function (foo: Bar): Baz {
  return { ... }
}
```

We have to also export the `Bar` type and any types it references,
otherwise typedoc cannot create the API docs for us.

Also swaps instances of `(default: foo)` to use `@default` jsdoc tags.
@achingbrain achingbrain requested a review from a team as a code owner September 24, 2024 08:41
@achingbrain achingbrain merged commit 7f7ec82 into main Sep 24, 2024
21 checks passed
@achingbrain achingbrain deleted the fix/export-documented-types branch September 24, 2024 09:39
@achingbrain achingbrain mentioned this pull request Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant