[packages] fix TypeDoc warnings in packages source comments #27498
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi there! 👋 I'm a bot whose goal is to ensure your contributions meet our guidelines. I've found some issues in your pull request that should be addressed (click on them for more details) 👇
|
Simek
requested review from
amandeepmittal,
tsapeta,
EvanBacon,
byCedric,
lukmccall,
Kudo and
ide
as code owners
amandeepmittal
approved these changes
Mar 7, 2024
tsapeta
approved these changes
Mar 8, 2024
This was referenced Apr 26, 2024
amandeepmittal
added a commit
that referenced
this pull request
Apr 26, 2024
# Why <!-- Please describe the motivation for this PR, and link to relevant GitHub issues, forums posts, or feature requests. --> Fixes #28480 # How <!-- How did you build this feature or fix this bug and why? --> Backport `@example` annotation fixes for expo-av, expo-contacts, and expo-application from #27498. # Test Plan <!-- Please describe how you tested this change and how a reviewer could reproduce your test, especially if this PR does not include automated tests! If possible, please also provide terminal output and/or screenshots demonstrating your test/reproduction. --> The changes have been regenerated from SDK 50 branch (and used git stash and git stash pop to commit changes). ## Preview  # Checklist <!-- Please check the appropriate items below if they apply to your diff. This is required for changes to Expo modules. --> - [ ] Documentation is up to date to reflect these changes (eg: https://docs.expo.dev and README.md). - [ ] Conforms with the [Documentation Writing Style Guide](https://github.com/expo/expo/blob/main/guides/Expo%20Documentation%20Writing%20Style%20Guide.md) - [ ] This diff will work correctly for `npx expo prebuild` & EAS Build (eg: updated a module plugin).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why
Address TypeDoc warning about packages source comments, which lead to invalid display in API Reference docs.
How
Address the TypeDoc warnings, rebuild the package files and re-generate data for API docs.
Test Plan
Affected by changes API Reference doc pages have been verified locally.
Preview