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

[FCE-1038] Update types exports (and typedoc) to make yarn docs happy #247

Merged
merged 4 commits into from
Jan 17, 2025

Conversation

mironiasty
Copy link
Member

@mironiasty mironiasty commented Jan 15, 2025

Description

Export all types that are visible to end user, but were not yet exported
Fix typedoc syntax marked as incorrect
Update typedoc config to avoid part of validation for libraries that are not actively supported

Motivation and Context

I want to update our documentation, but as part of this process I want to remove warnings (and also add missing types into docs)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to
    not work as expected)

Copy link

linear bot commented Jan 15, 2025

@mironiasty mironiasty marked this pull request as ready for review January 15, 2025 15:43
Copy link
Collaborator

@czerwiukk czerwiukk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm and i've even checked - it truly does eliminate the warnings

@mironiasty mironiasty merged commit 1138eeb into main Jan 17, 2025
2 checks passed
@mironiasty mironiasty deleted the fix-docs-warnings branch January 17, 2025 14:46
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.

2 participants