search

ionic-team / capacitor-plugins

Official plugins for Capacitor ⚡️
532 stars 596 forks source link

Wrong/incomplete JS-Doc in Camera-Plugin #2195

Open flgubler-ergon opened 2 months ago

flgubler-ergon commented 2 months ago

Bug Report

Plugin(s)

Camera plugin

Capacitor Version

  @capacitor/cli: 6.1.0
  @capacitor/core: 6.1.0
  @capacitor/android: 6.1.0
  @capacitor/ios: 6.1.0

Platform(s)

Web (iOS)

Current Behavior

The property presentationStyle has the following JS-doc

    /**
     * iOS only: The presentation style of the Camera.
     * @default: 'fullscreen'
     *
     * @since 1.0.0
     */
    presentationStyle?: 'fullscreen' | 'popover';

It sais that the property only influences the style of the camera. But in reality, it also influences the style of the photo-picker in the same way.

Expected Behavior

The JS-doc should specify that the photo-picker also influenced by the property.

Code Reproduction

I guess this does not really make sense, here, but I am talking about this file: https://github.com/ionic-team/capacitor-plugins/blob/main/camera/src/definitions.ts

ionitron-bot[bot] commented 1 month ago

This issue has been labeled as type: bug. This label is added to issues that that have been reproduced and are being tracked in our internal issue tracker.