Documentation to inform of deprecated components and APIs (facebook#501)

reason-react-native/src/apis/Animated.md

@@ -296,4 +296,4 @@ module View = {
   let make = createAnimatedComponent(View.make);
 };
 
-```
+```

reason-react-native/src/apis/AppRegistry.re

@@ -9,5 +9,4 @@ type app = {
   [@bs.meth] "getStyleElement": unit => React.element,
 };
 [@bs.module "react-native"] [@bs.scope "AppRegistry"]
-external getApplication: (string, {. "initialProps": 'a}) => app =
-  "";
+external getApplication: (string, {. "initialProps": 'a}) => app = "";

reason-react-native/src/apis/AppState.md

@@ -30,5 +30,5 @@ external removeEventListener:
   ([@bs.string] [ | `change(t => unit) | `memoryWarning(unit => unit)]) =>
   unit =
   "";
-  
+
 ```

reason-react-native/src/apis/BackAndroid.md

@@ -0,0 +1,8 @@
+---
+id: apis/BackAndroid
+title: BackAndroid
+---
+
+This API is deprecated and therefore out of scope for this project.
+
+Please use [`BackHandler`](../BackHandler/) instead.

reason-react-native/src/apis/CameraRoll.md

@@ -5,43 +5,57 @@ title: CameraRoll
 
 ## Methods
 
-- `saveToCameraRoll` allows saving photos and videos to the Camera Roll or Photo Gallery. File to be saved is specified as a tag which can be
+- `saveToCameraRoll` allows saving photos and videos to the Camera Roll or Photo
+  Gallery. File to be saved is specified as a tag which can be
 
-   - on Android, a local image or video URI, such as "file:///sdcard/img.png"
-   - on iOS, a local video URI or any image URI (local, remote asset-library, or base64 data URIs)
+  - on Android, a local image or video URI, such as "file:///sdcard/img.png"
+  - on iOS, a local video URI or any image URI (local, remote asset-library, or
+    base64 data URIs)
 
-Media type (photo or video) will be automatically inferred; any file will be inferred to be a photo, unless the file extension is `mov` or `mp4`, then it will be inferred to be a video.
+Media type (photo or video) will be automatically inferred; any file will be
+inferred to be a photo, unless the file extension is `mov` or `mp4`, then it
+will be inferred to be a video.
 
 ```reason
 saveToCameraRoll(tag)
 ```
 
-The function will return the URI for the saved file as a string wrapped in a Promise, `Js.Promise.t(string)`.
+The function will return the URI for the saved file as a string wrapped in a
+Promise, `Js.Promise.t(string)`.
 
-- `saveToCameraRollWithType` allows saving photos and videos to the Camera Roll, where the tag will be specified as above, overriding the automatically determined type.
+- `saveToCameraRollWithType` allows saving photos and videos to the Camera Roll,
+  where the tag will be specified as above, overriding the automatically
+  determined type.
 
 ```reason
 saveToCameraRollWithType(tag, _type)
 ```
 
 where `_type` can be `` `photo `` or `` `video ``.
 
-The function will return the URI for the saved file as a string wrapped in a Promise, `Js.Promise.t(string)`.
+The function will return the URI for the saved file as a string wrapped in a
+Promise, `Js.Promise.t(string)`.
 
 - `getPhotos` takes as argument `getPhotosParams`
 
 ```reason
 getPhotos(getPhotosParams)
 ```
 
-The function will return a `photoIdentifiersPage` object wrapped in a Promise, that is `Js.Promise.t(photoIdentifiersPage)`. Array of `photoIdentifier` will contain details of photos or videos matching parameters provided in the `getPhotosParam` object.
-
+The function will return a `photoIdentifiersPage` object wrapped in a Promise,
+that is `Js.Promise.t(photoIdentifiersPage)`. Array of `photoIdentifier` will
+contain details of photos or videos matching parameters provided in the
+`getPhotosParam` object.
 
 ## Types
 
 - `getPhotosParams` can be constructed with the constructor of the same name
-    - `first` takes an integer which specifies the number of files for which details will be returned. Files will match in reverse order (i.e. most recent first)
-    - `after` takes a string which should be obtained from `photoIdentifiersPage` returned in a previous `getPhotos` call, under the `end_cursor` key contained in turn under the `page_info` key.
+  - `first` takes an integer which specifies the number of files for which
+    details will be returned. Files will match in reverse order (i.e. most
+    recent first)
+  - `after` takes a string which should be obtained from `photoIdentifiersPage`
+    returned in a previous `getPhotos` call, under the `end_cursor` key
+    contained in turn under the `page_info` key.
 
 ```reason
 getPhotosParams:

reason-react-native/src/apis/Keyboard.md

@@ -94,4 +94,4 @@ external removeListener:
 [@bs.module "react-native"] [@bs.scope "Keyboard"]
 external dismiss: unit => unit = "";
 
-```
+```

reason-react-native/src/apis/Keyboard.rei

@@ -85,4 +85,4 @@ external removeListener:
   "";
 
 [@bs.module "react-native"] [@bs.scope "Keyboard"]
-external dismiss: unit => unit = "";
+external dismiss: unit => unit = "";

reason-react-native/src/apis/LayoutAnimation.re

@@ -70,7 +70,6 @@ external linear: unit => unit = "";
 [@bs.module "react-native"] [@bs.scope "LayoutAnimation"]
 external spring: unit => unit = "";
 
-
 module Presets = {
   [@bs.module "react-native"] [@bs.scope ("LayoutAnimation", "Presets")]
   external easeInEaseOut: layoutAnimationConfig = "";
@@ -80,4 +79,4 @@ module Presets = {
 
   [@bs.module "react-native"] [@bs.scope ("LayoutAnimation", "Presets")]
   external spring: layoutAnimationConfig = "";
-};
+};

reason-react-native/src/apis/Linking.md

@@ -36,4 +36,4 @@ external removeEventListener:
   ([@bs.string] [ | `url], {. "url": string} => unit) => unit =
   "";
 
-```
+```

reason-react-native/src/apis/ListViewDataSource.md

@@ -0,0 +1,11 @@
+---
+id: apis/ListViewDataSource
+title: ListViewDataSource
+---
+
+This API is intended for use with the `ListView` component. As the component is
+deprecated, the API is out of scope for this project.
+
+Instead of `ListView`, please use another list component, such as
+[`FlatList`](../../components/FlatList/) or
+[`SectionList`](../../components/SectionList/).

reason-react-native/src/apis/PermissionsAndroid.md

@@ -151,5 +151,5 @@ external requestWithRationale:
 external requestMultiple: array(Permission.t) => Js.Promise.t(dict) = "";
 
 [@bs.get_index] external get: (dict, Permission.t) => option(Result.t) = "";
-  
-```
+
+```

reason-react-native/src/apis/PushNotificationIOS.md

@@ -204,4 +204,4 @@ external getInitialNotification:
   unit => Js.Promise.t(Js.Nullable.t(Notification.t)) =
   "";
 
-```
+```

reason-react-native/src/apis/Style.rei

@@ -239,4 +239,4 @@ external list: list(t) => t = "%identity";
    cond ? Some({something:"dynamic"}) : None
  ])>
  */
-external listOption: list(option(t)) => t = "%identity";
+external listOption: list(option(t)) => t = "%identity";

reason-react-native/src/components/ListView.md

@@ -0,0 +1,9 @@
+---
+id: components/ListView
+title: ListView
+---
+
+`ListView` component is deprecated and therefore out of scope for this project.
+
+Instead of `ListView`, please use another list component, such as
+[`FlatList`](../FlatList/) or [`SectionList`](../SectionList/).

reason-react-native/src/components/Modal.re

@@ -11,7 +11,12 @@ external make:
     ~animationType: [@bs.string] [ | `none | `slide | `fade]=?,
     ~hardwareAccelerated: bool=?,
     ~onDismiss: unit => unit=?,
-    ~onOrientationChange: Event.syntheticEvent({. "orientation": OrientationChange.t}) => unit=?,
+    ~onOrientationChange: Event.syntheticEvent({
+                            .
+                            "orientation": OrientationChange.t,
+                          }) =>
+                          unit
+                            =?,
     ~onRequestClose: unit => unit=?,
     ~onShow: unit => unit=?,
     ~presentationStyle: [@bs.string] [

reason-react-native/src/elements/ScrollViewMethods.re

@@ -12,10 +12,10 @@ module Make = (T: {type t;}) => {
   external scrollToEndOptions:
     (~animated: bool=?, ~duration: float=?, unit) => scrollToEndOptions =
     "";
-  
+
   // multiple externals
   [@bs.send] external scrollToEnd: T.t => unit = "";
-  
+
   // multiple externals
   [@bs.send]
   external scrollToEndWithOptions: (T.t, scrollToEndOptions) => unit =

reason-react-native/src/types/AccessibilityState.rei

@@ -4,4 +4,4 @@ type t;
 let selected: t;
 
 [@bs.inline "disabled"]
-let disabled: t;
+let disabled: t;

reason-react-native/src/types/AccessibilityTrait.rei

@@ -49,4 +49,4 @@ let adjustable: t;
 let allowsDirectInteraction: t;
 
 [@bs.inline "pageTurn"]
-let pageTurn: t;
+let pageTurn: t;

reason-react-native/src/types/ActivityIndicator_Size.rei

@@ -6,4 +6,4 @@ let small: t;
 [@bs.inline "large"]
 let large: t;
 
-external exact: float => t = "%identity";
+external exact: float => t = "%identity";

reason-react-native/src/types/FontVariant.rei

@@ -13,4 +13,4 @@ let liningNums: t;
 let tabularNums: t;
 
 [@bs.inline "proportional-nums"]
-let proportionalNums: t;
+let proportionalNums: t;

reason-react-native/src/types/Modal_Orientation.rei

@@ -13,4 +13,4 @@ let landscapeRight: t;
 let portrait: t;
 
 [@bs.inline "portrait-upside-down"]
-let portraitUpsideDown: t;
+let portraitUpsideDown: t;

reason-react-native/src/types/TextInput_DataDetectorTypes.rei

@@ -16,4 +16,4 @@ let calendarEvent: t;
 let none: t;
 
 [@bs.inline "all"]
-let all: t;
+let all: t;

reason-react-native/src/types/WebView_DataDetectorTypes.rei

@@ -25,4 +25,4 @@ let trackingNumber: t;
 let flightNumber: t;
 
 [@bs.inline "lookupSuggestion"]
-let lookupSuggestion: t;
+let lookupSuggestion: t;

reason-react-native/src/types/WebView_DecelerationRate.rei

@@ -6,4 +6,4 @@ external value: float => t = "%identity";
 let normal: t;
 
 [@bs.inline "fast"]
-let fast: t;
+let fast: t;