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.

Sign up for GitHub

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

Jump to bottom

CI job to ensure ts implementation details don't end up in docs #5273

Open
hoodmane opened this issue Dec 23, 2024 · 2 comments
Open

CI job to ensure ts implementation details don't end up in docs #5273

hoodmane opened this issue Dec 23, 2024 · 2 comments
Labels
enhancement New feature or request

Comments

@hoodmane
Copy link
Member

We should make a ci job that compares the JS api docs against a list and fails if that list changes. If we are intentionally adding documentation items, we can update the list and otherwise it will remind us to add /** @private */.
@hoodmane hoodmane added the enhancement New feature or request label Dec 23, 2024
@hoodmane hoodmane mentioned this issue Dec 23, 2024
Merged
@ryanking13
Copy link
Member

Instead of putting @private everywhere, would there be a way we can put @public flag and only display APIs that we mark as public?

@hoodmane
Copy link
Member Author

That would make more sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hoodmane @ryanking13