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

[docs] @example tags are not rendered correctly #28480

Closed
RRaideRR opened this issue Apr 26, 2024 · 1 comment · Fixed by #28488
Closed

[docs] @example tags are not rendered correctly #28480

RRaideRR opened this issue Apr 26, 2024 · 1 comment · Fixed by #28488
Assignees
@amandeepmittal
Labels
docs

Comments

@RRaideRR
Copy link
Contributor

Summary

I noticed that the "@example" tags in the TS files are not rendered correctly anymore. They are missing in the rendered documentation.

Bildschirmfoto 2024-04-26 um 14 47 22 Bildschirmfoto 2024-04-26 um 14 48 00

This occurs on multiple cases in the documentation (not only expo-av but also e.g. expo-contacts). So it seems to be an issue with the underlying "documentation rendering engine"

Link to the related docs page

https://docs.expo.dev/versions/latest/sdk/audio/#recordingoptionsandroid

Anything else?

No response
@RRaideRR RRaideRR added the docs label Apr 26, 2024
@RRaideRR RRaideRR changed the title [docs] @example are not rendered correctly [docs] @example tags are not rendered correctly Apr 26, 2024
@amandeepmittal amandeepmittal self-assigned this Apr 26, 2024
@amandeepmittal
Copy link
Member

amandeepmittal commented Apr 26, 2024 •
edited

Hi @RRaideRR, we did fix them in #27498 (for expo-av, expo-contacts, expo-application, etc.). The fixed examples are in SDK 51. For example, for sampleRate in expo-av. They weren't backported to SDK 50 but will look into it.

For other API references, I'll check any missing ones and update them accordingly.
Thanks for catching this!

@amandeepmittal amandeepmittal mentioned this issue Apr 26, 2024
Merged
3 tasks
amandeepmittal added a commit that referenced this issue Apr 26, 2024
@amandeepmittal
[docs] Backport @example tags fixes to SDK 50 (#28488)
4e32873 
# 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

![CleanShot 2024-04-27 at 00 00
39](https://github.com/expo/expo/assets/10234615/05b74e2f-1fd6-488b-a077-825bee50bf0b)


# 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
Assignees

@amandeepmittal amandeepmittal

Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs] Backport @example tags fixes to SDK 50 expo/expo
2 participants
@RRaideRR @amandeepmittal