Skip to content

Conversation

@matus-vacula
Copy link
Contributor

No description provided.

@matus-vacula matus-vacula requested review from pavkam and roncohen March 6, 2025 09:52
@roncohen
Copy link
Contributor

roncohen commented Mar 6, 2025

thanks! There are some types that we purposefully didn't export but that we are still using.
For example, this is not that useful to have in the list of exported types in the docs:

type EmptyFeatureRemoteConfig = { key: undefined; payload: undefined };

It would be fine that the docs just wrote those out, so that instead of

type SomeType = SomeOtherType | EmptyFeatureRemoteConfig

it would be

type SomeType = SomeOtherType | { key: undefined; payload: undefined };

So the idea was that it would just document those unexported typed as a copy of their definition rather than refer to them by name and then expose a hole bunch of simple/useless names types.

It looks like https://github.com/Gerrit0/typedoc-plugin-missing-exports actually does this. Are you familiar with that by any chance?

@roncohen
Copy link
Contributor

roncohen commented Mar 6, 2025

Never mind, that doesn't do what I hoped:

Screenshot 2025-03-06 at 12 01 17

@roncohen
Copy link
Contributor

roncohen commented Mar 6, 2025

actually this might still be better. The idea is to keep what the SDK exposes minimal. We still want it to be documented though, so maybe this is a good middle way.. hmm

Copy link
Contributor

@roncohen roncohen left a comment

Choose a reason for hiding this comment

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

never mind, lets just get this in for now.

@matus-vacula matus-vacula force-pushed the fail_on_docs_warnings branch from d9dd1d4 to 7b2deae Compare March 10, 2025 09:44
@matus-vacula matus-vacula merged commit c672cd2 into main Mar 10, 2025
5 checks passed
@matus-vacula matus-vacula deleted the fail_on_docs_warnings branch March 10, 2025 09:57
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