Skip to content

Conversation

antoniovini47
Copy link

@antoniovini47 antoniovini47 commented Jun 4, 2025

Really simple typo errors

Description

Fixes #

Added your feature that allows ...

Checklist

  • I've read CONTRIBUTING.md
  • I updated the doc/other generated code with running yarn generate in the root folder
  • I have tested the new feature on /example app.
    • In V11 mode/ios
    • In New Architecture mode/ios
    • In V11 mode/android
    • In New Architecture mode/android
  • I added/updated a sample - if a new feature was implemented (/example)

Screenshot OR Video

Component to reproduce the issue you're fixing

Really simple typo errors
@rnmapbox-bot
Copy link
Contributor

Hi @antoniovini47! 👋

Thank you for taking the time to contribute to @rnmapbox/maps! I really appreciate your attention to detail in spotting documentation issues.

However, I noticed that the docs/OfflineManager.md file you're modifying is actually auto-generated from the source TypeScript file (src/modules/offline/offlineManager.ts), as indicated by the comment at the top of the file:

<!-- This file was autogenerated from offlineManager.ts do not modify -->

To properly fix the documentation:

  1. Please modify the JSDoc comments in the source file at src/modules/offline/offlineManager.ts instead
  2. After making your changes, run yarn generate from the root folder to regenerate the documentation

Looking at the source file, the createPack method signature appears to already use TypeScript's optional parameter syntax (lines 103-107), so the generated documentation should reflect that correctly after running yarn generate.

Could you please update your PR to modify the source file instead and regenerate the docs? This will ensure the changes persist and don't get overwritten the next time someone runs the generation script.

Thanks again for helping improve the documentation! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants