maps icon indicating copy to clipboard operation
maps copied to clipboard

Updates documentation regarding queryRenderedFeaturesInRect.

Open uzun0ff opened this issue 6 months ago • 1 comments

Description

Updates the description for queryRenderedFeaturesInRect's argument BBox as how to use it correctly.

Checklist

  • [x] 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


uzun0ff avatar Jun 17 '25 14:06 uzun0ff

Hi @uzun0ff, thank you for contributing this documentation update! 🙏

I see you're adding a helpful note about a limitation with BBox queries in queryRenderedFeaturesInRect. This is valuable information for developers using this API.

However, I noticed that you've directly edited the docs/MapView.md file. In this repository, documentation files in the docs/ folder are auto-generated from the source code. To make this change properly, you'll need to:

  1. Update the JSDoc comment for queryRenderedFeaturesInRect in the source file: src/components/MapView.tsx (around line 838)
  2. Run yarn generate to regenerate the documentation

This ensures the documentation stays in sync with the code and won't be overwritten the next time someone runs the generation script.

Could you please update the source file instead and run yarn generate? The note you're adding about using device layout dimensions as a workaround is definitely helpful context that should be preserved!

Since this is marked as a draft PR, feel free to make these changes and let me know when it's ready for review. Happy to help if you have any questions!

rnmapbox-bot avatar Aug 08 '25 04:08 rnmapbox-bot