From 357a28e5cf0ddd37368783856e7ff43d5d528187 Mon Sep 17 00:00:00 2001 From: Jesse Squires Date: Fri, 12 May 2017 10:33:40 -0700 Subject: [PATCH] final docs update for 3.0 Summary: Closes https://github.com/Instagram/IGListKit/pull/738 Differential Revision: D5052802 Pulled By: jessesquires fbshipit-source-id: b1ace763da9edbb7bc65ecb9af34aa791e617aa7 --- docs/Categories.html | 2 +- docs/Classes.html | 2 +- docs/Classes/IGListAdapter.html | 2 +- docs/Classes/IGListAdapterUpdater.html | 2 +- docs/Classes/IGListBatchUpdateData.html | 2 +- docs/Classes/IGListBindingSectionController.html | 2 +- docs/Classes/IGListCollectionViewLayout.html | 2 +- docs/Classes/IGListGenericSectionController.html | 2 +- docs/Classes/IGListIndexPathResult.html | 2 +- docs/Classes/IGListIndexSetResult.html | 2 +- docs/Classes/IGListMoveIndex.html | 2 +- docs/Classes/IGListMoveIndexPath.html | 2 +- docs/Classes/IGListSectionController.html | 2 +- docs/Classes/IGListSingleSectionController.html | 2 +- docs/Classes/IGListStackedSectionController.html | 2 +- docs/Constants.html | 2 +- docs/Enums.html | 2 +- docs/Enums/IGListDiffOption.html | 2 +- docs/Enums/IGListExperiment.html | 2 +- docs/Functions.html | 2 +- docs/Guides.html | 2 +- docs/Protocols.html | 2 +- docs/Protocols/IGListAdapterDataSource.html | 2 +- docs/Protocols/IGListAdapterDelegate.html | 2 +- docs/Protocols/IGListAdapterUpdaterDelegate.html | 2 +- docs/Protocols/IGListBatchContext.html | 2 +- docs/Protocols/IGListBindable.html | 2 +- .../IGListBindingSectionControllerDataSource.html | 2 +- .../IGListBindingSectionControllerSelectionDelegate.html | 2 +- docs/Protocols/IGListCollectionContext.html | 2 +- docs/Protocols/IGListDiffable.html | 2 +- docs/Protocols/IGListDisplayDelegate.html | 2 +- docs/Protocols/IGListScrollDelegate.html | 2 +- docs/Protocols/IGListSingleSectionControllerDelegate.html | 2 +- docs/Protocols/IGListSupplementaryViewSource.html | 2 +- docs/Protocols/IGListUpdatingDelegate.html | 2 +- docs/Protocols/IGListWorkingRangeDelegate.html | 2 +- docs/Type Definitions.html | 2 +- docs/best-practices-and-faq.html | 2 +- docs/getting-started.html | 2 +- docs/iglistdiffable-and-equality.html | 2 +- docs/index.html | 6 +++--- docs/installation.html | 8 ++++---- docs/migration.html | 2 +- docs/undocumented.json | 6 +++--- docs/vision.html | 2 +- docs/working-with-core-data.html | 2 +- docs/working-with-uicollectionview.html | 2 +- 48 files changed, 55 insertions(+), 55 deletions(-) diff --git a/docs/Categories.html b/docs/Categories.html index 95c42f3bb..1a8437af4 100644 --- a/docs/Categories.html +++ b/docs/Categories.html @@ -307,7 +307,7 @@

Declaration

diff --git a/docs/Classes.html b/docs/Classes.html index cda74ac27..8441f1d2c 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -827,7 +827,7 @@

Declaration

diff --git a/docs/Classes/IGListAdapter.html b/docs/Classes/IGListAdapter.html index 1dd40a6a8..bf43c06cd 100644 --- a/docs/Classes/IGListAdapter.html +++ b/docs/Classes/IGListAdapter.html @@ -1454,7 +1454,7 @@

Return Value

diff --git a/docs/Classes/IGListAdapterUpdater.html b/docs/Classes/IGListAdapterUpdater.html index 33aa9b6af..83a2bc567 100644 --- a/docs/Classes/IGListAdapterUpdater.html +++ b/docs/Classes/IGListAdapterUpdater.html @@ -386,7 +386,7 @@

Declaration

diff --git a/docs/Classes/IGListBatchUpdateData.html b/docs/Classes/IGListBatchUpdateData.html index 4675693d9..2a5c26ec9 100644 --- a/docs/Classes/IGListBatchUpdateData.html +++ b/docs/Classes/IGListBatchUpdateData.html @@ -541,7 +541,7 @@

Return Value

diff --git a/docs/Classes/IGListBindingSectionController.html b/docs/Classes/IGListBindingSectionController.html index ff2c527ff..3356f7bb8 100644 --- a/docs/Classes/IGListBindingSectionController.html +++ b/docs/Classes/IGListBindingSectionController.html @@ -452,7 +452,7 @@

Parameters

diff --git a/docs/Classes/IGListCollectionViewLayout.html b/docs/Classes/IGListCollectionViewLayout.html index ab04e23f2..0952496e6 100644 --- a/docs/Classes/IGListCollectionViewLayout.html +++ b/docs/Classes/IGListCollectionViewLayout.html @@ -412,7 +412,7 @@

Return Value

diff --git a/docs/Classes/IGListGenericSectionController.html b/docs/Classes/IGListGenericSectionController.html index 7cf3afd16..c40812d5b 100644 --- a/docs/Classes/IGListGenericSectionController.html +++ b/docs/Classes/IGListGenericSectionController.html @@ -344,7 +344,7 @@

Parameters

diff --git a/docs/Classes/IGListIndexPathResult.html b/docs/Classes/IGListIndexPathResult.html index 839911f14..264ec5b8c 100644 --- a/docs/Classes/IGListIndexPathResult.html +++ b/docs/Classes/IGListIndexPathResult.html @@ -573,7 +573,7 @@

Declaration

diff --git a/docs/Classes/IGListIndexSetResult.html b/docs/Classes/IGListIndexSetResult.html index 4b08c4451..ddf87d691 100644 --- a/docs/Classes/IGListIndexSetResult.html +++ b/docs/Classes/IGListIndexSetResult.html @@ -570,7 +570,7 @@

Declaration

diff --git a/docs/Classes/IGListMoveIndex.html b/docs/Classes/IGListMoveIndex.html index b4e676d60..f175d9672 100644 --- a/docs/Classes/IGListMoveIndex.html +++ b/docs/Classes/IGListMoveIndex.html @@ -321,7 +321,7 @@

Declaration

diff --git a/docs/Classes/IGListMoveIndexPath.html b/docs/Classes/IGListMoveIndexPath.html index c4b6a0a19..53e003f0e 100644 --- a/docs/Classes/IGListMoveIndexPath.html +++ b/docs/Classes/IGListMoveIndexPath.html @@ -321,7 +321,7 @@

Declaration

diff --git a/docs/Classes/IGListSectionController.html b/docs/Classes/IGListSectionController.html index c542fcf1e..d568773a2 100644 --- a/docs/Classes/IGListSectionController.html +++ b/docs/Classes/IGListSectionController.html @@ -913,7 +913,7 @@

Return Value

diff --git a/docs/Classes/IGListSingleSectionController.html b/docs/Classes/IGListSingleSectionController.html index edceb9fbf..1d3e4f846 100644 --- a/docs/Classes/IGListSingleSectionController.html +++ b/docs/Classes/IGListSingleSectionController.html @@ -552,7 +552,7 @@

Declaration

diff --git a/docs/Classes/IGListStackedSectionController.html b/docs/Classes/IGListStackedSectionController.html index 6a322715a..2d93ce441 100644 --- a/docs/Classes/IGListStackedSectionController.html +++ b/docs/Classes/IGListStackedSectionController.html @@ -321,7 +321,7 @@

Parameters

diff --git a/docs/Constants.html b/docs/Constants.html index 0721c9fe0..eb914b0b5 100644 --- a/docs/Constants.html +++ b/docs/Constants.html @@ -303,7 +303,7 @@

Declaration

diff --git a/docs/Enums.html b/docs/Enums.html index a4e9cb419..54173d8c1 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -319,7 +319,7 @@

Declaration

diff --git a/docs/Enums/IGListDiffOption.html b/docs/Enums/IGListDiffOption.html index 1361fa298..ea0523d2e 100644 --- a/docs/Enums/IGListDiffOption.html +++ b/docs/Enums/IGListDiffOption.html @@ -320,7 +320,7 @@

Declaration

diff --git a/docs/Enums/IGListExperiment.html b/docs/Enums/IGListExperiment.html index 32e4597f7..4edf38aae 100644 --- a/docs/Enums/IGListExperiment.html +++ b/docs/Enums/IGListExperiment.html @@ -288,7 +288,7 @@

Declaration

diff --git a/docs/Functions.html b/docs/Functions.html index 0045d0e66..efd69f40f 100644 --- a/docs/Functions.html +++ b/docs/Functions.html @@ -711,7 +711,7 @@

Return Value

diff --git a/docs/Guides.html b/docs/Guides.html index 6fd469c2a..af9a08272 100644 --- a/docs/Guides.html +++ b/docs/Guides.html @@ -245,7 +245,7 @@

Guides

diff --git a/docs/Protocols.html b/docs/Protocols.html index e4b12649f..6505617b3 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -763,7 +763,7 @@

Declaration

diff --git a/docs/Protocols/IGListAdapterDataSource.html b/docs/Protocols/IGListAdapterDataSource.html index d991a27a8..a0f14ac91 100644 --- a/docs/Protocols/IGListAdapterDataSource.html +++ b/docs/Protocols/IGListAdapterDataSource.html @@ -439,7 +439,7 @@

Return Value

diff --git a/docs/Protocols/IGListAdapterDelegate.html b/docs/Protocols/IGListAdapterDelegate.html index 9db20ebac..b6ac0f714 100644 --- a/docs/Protocols/IGListAdapterDelegate.html +++ b/docs/Protocols/IGListAdapterDelegate.html @@ -410,7 +410,7 @@

Parameters

diff --git a/docs/Protocols/IGListAdapterUpdaterDelegate.html b/docs/Protocols/IGListAdapterUpdaterDelegate.html index 05e7b4412..55508b848 100644 --- a/docs/Protocols/IGListAdapterUpdaterDelegate.html +++ b/docs/Protocols/IGListAdapterUpdaterDelegate.html @@ -1007,7 +1007,7 @@

Parameters

diff --git a/docs/Protocols/IGListBatchContext.html b/docs/Protocols/IGListBatchContext.html index c57ea77f9..737361dcc 100644 --- a/docs/Protocols/IGListBatchContext.html +++ b/docs/Protocols/IGListBatchContext.html @@ -582,7 +582,7 @@

Parameters

diff --git a/docs/Protocols/IGListBindable.html b/docs/Protocols/IGListBindable.html index 1e3b183ec..b74255071 100644 --- a/docs/Protocols/IGListBindable.html +++ b/docs/Protocols/IGListBindable.html @@ -313,7 +313,7 @@

Parameters

diff --git a/docs/Protocols/IGListBindingSectionControllerDataSource.html b/docs/Protocols/IGListBindingSectionControllerDataSource.html index 4ae80bb25..758a2cf4f 100644 --- a/docs/Protocols/IGListBindingSectionControllerDataSource.html +++ b/docs/Protocols/IGListBindingSectionControllerDataSource.html @@ -490,7 +490,7 @@

Return Value

diff --git a/docs/Protocols/IGListBindingSectionControllerSelectionDelegate.html b/docs/Protocols/IGListBindingSectionControllerSelectionDelegate.html index 4e2fbfbd4..0187d11a1 100644 --- a/docs/Protocols/IGListBindingSectionControllerSelectionDelegate.html +++ b/docs/Protocols/IGListBindingSectionControllerSelectionDelegate.html @@ -334,7 +334,7 @@

Parameters

diff --git a/docs/Protocols/IGListCollectionContext.html b/docs/Protocols/IGListCollectionContext.html index eae27261c..13e54fb20 100644 --- a/docs/Protocols/IGListCollectionContext.html +++ b/docs/Protocols/IGListCollectionContext.html @@ -1505,7 +1505,7 @@

Parameters

diff --git a/docs/Protocols/IGListDiffable.html b/docs/Protocols/IGListDiffable.html index e559af938..9cc83b912 100644 --- a/docs/Protocols/IGListDiffable.html +++ b/docs/Protocols/IGListDiffable.html @@ -359,7 +359,7 @@

Return Value

diff --git a/docs/Protocols/IGListDisplayDelegate.html b/docs/Protocols/IGListDisplayDelegate.html index 26808876e..57463e09f 100644 --- a/docs/Protocols/IGListDisplayDelegate.html +++ b/docs/Protocols/IGListDisplayDelegate.html @@ -548,7 +548,7 @@

Parameters

diff --git a/docs/Protocols/IGListScrollDelegate.html b/docs/Protocols/IGListScrollDelegate.html index 6160aca20..6cf1738fa 100644 --- a/docs/Protocols/IGListScrollDelegate.html +++ b/docs/Protocols/IGListScrollDelegate.html @@ -437,7 +437,7 @@

Parameters

diff --git a/docs/Protocols/IGListSingleSectionControllerDelegate.html b/docs/Protocols/IGListSingleSectionControllerDelegate.html index 56245e6cb..be7cd8d95 100644 --- a/docs/Protocols/IGListSingleSectionControllerDelegate.html +++ b/docs/Protocols/IGListSingleSectionControllerDelegate.html @@ -316,7 +316,7 @@

Parameters

diff --git a/docs/Protocols/IGListSupplementaryViewSource.html b/docs/Protocols/IGListSupplementaryViewSource.html index 394055933..98094f069 100644 --- a/docs/Protocols/IGListSupplementaryViewSource.html +++ b/docs/Protocols/IGListSupplementaryViewSource.html @@ -422,7 +422,7 @@

Return Value

diff --git a/docs/Protocols/IGListUpdatingDelegate.html b/docs/Protocols/IGListUpdatingDelegate.html index 3063b4735..5481b36a0 100644 --- a/docs/Protocols/IGListUpdatingDelegate.html +++ b/docs/Protocols/IGListUpdatingDelegate.html @@ -912,7 +912,7 @@

Parameters

diff --git a/docs/Protocols/IGListWorkingRangeDelegate.html b/docs/Protocols/IGListWorkingRangeDelegate.html index bc5d294e6..ac0fcaedb 100644 --- a/docs/Protocols/IGListWorkingRangeDelegate.html +++ b/docs/Protocols/IGListWorkingRangeDelegate.html @@ -379,7 +379,7 @@

Parameters

diff --git a/docs/Type Definitions.html b/docs/Type Definitions.html index 8fac0735b..e8876a266 100644 --- a/docs/Type Definitions.html +++ b/docs/Type Definitions.html @@ -571,7 +571,7 @@

Declaration

diff --git a/docs/best-practices-and-faq.html b/docs/best-practices-and-faq.html index 13cd28802..5d2da08d3 100644 --- a/docs/best-practices-and-faq.html +++ b/docs/best-practices-and-faq.html @@ -373,7 +373,7 @@

Custom Updaters

diff --git a/docs/iglistdiffable-and-equality.html b/docs/iglistdiffable-and-equality.html index 5bc9bf05b..06ce8bf96 100644 --- a/docs/iglistdiffable-and-equality.html +++ b/docs/iglistdiffable-and-equality.html @@ -331,7 +331,7 @@

Installation

CocoaPods

The preferred installation method is with CocoaPods. Add the following to your Podfile:

-
pod 'IGListKit', '~> 3.0.0'
+
pod 'IGListKit', '~> 3.0'
 

 
Carthage

 
 
For Carthage, add the following to your Cartfile:

-
github "Instagram/IGListKit" ~> 3.0.0
+
github "Instagram/IGListKit" ~> 3.0
 

 
 

@@ -367,7 +367,7 @@ 
License

           
         
         
       
diff --git a/docs/installation.html b/docs/installation.html
index ec2140137..edb7167da 100644
--- a/docs/installation.html
+++ b/docs/installation.html
@@ -246,7 +246,7 @@ 
CocoaPods

 
The preferred method of installation for IGListKit is using CocoaPods.

 
 
In order to use the latest release of the framework, add the following to your Podfile:

-
pod 'IGListKit', '~> 3.0.0'
+
pod 'IGListKit', '~> 3.0'
 

 
Using master

 
@@ -262,7 +262,7 @@ 
Subspecs

 
With the exception of macOS (which currently only supports the diffing algorithm components), using pod 'IGListKit' will get you the full library, including the flexible UICollectionView system. Learn more about how to get started in our Getting Started guide.

 
 
However, if you only want to use the diffing components of this library, then you can use the diffing subspec in your Podfile:

-
pod 'IGListKit/Diffing', '~> 3.0.0'
+
pod 'IGListKit/Diffing', '~> 3.0'
 

 
 
Regardless of whether you only use the diffing components, or the entire library, the imports are the same:

@@ -271,13 +271,13 @@ 
Subspecs

 
Carthage

 
 
If using Carthage, add the following to your Cartfile:

-
github "Instagram/IGListKit" ~> 3.0.0
+
github "Instagram/IGListKit" ~> 3.0
 

 
           
         
         
       
diff --git a/docs/migration.html b/docs/migration.html
index 09e4e1e37..e83dfcec1 100644
--- a/docs/migration.html
+++ b/docs/migration.html
@@ -358,7 +358,7 @@ 
IGListDiffab
           
         
         
       
diff --git a/docs/undocumented.json b/docs/undocumented.json
index ae7656e46..64adf776a 100644
--- a/docs/undocumented.json
+++ b/docs/undocumented.json
@@ -1,19 +1,19 @@
 {
   "warnings": [
     {
-      "file": "/Users/rnystrom/Development/iOS/IGListKit/IGListKit/IGListDiff.h",
+      "file": "/Users/jesse/GitHub/IGListKit/IGListKit/IGListDiff.h",
       "line": 21,
       "symbol": "IGListDiffOption",
       "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef",
       "warning": "undocumented"
     },
     {
-      "file": "/Users/rnystrom/Development/iOS/IGListKit/IGListKit/IGListExperiments.h",
+      "file": "/Users/jesse/GitHub/IGListKit/IGListKit/IGListExperiments.h",
       "line": 17,
       "symbol": "IGListExperiment",
       "symbol_kind": "sourcekitten.source.lang.objc.decl.typedef",
       "warning": "undocumented"
     }
   ],
-  "source_directory": "/Users/rnystrom/Development/iOS/IGListKit"
+  "source_directory": "/Users/jesse/GitHub/IGListKit"
 }
\ No newline at end of file
diff --git a/docs/vision.html b/docs/vision.html
index 268a4089e..df0071a8b 100644
--- a/docs/vision.html
+++ b/docs/vision.html
@@ -276,7 +276,7 @@ 
Communication

           
         
         
       
diff --git a/docs/working-with-core-data.html b/docs/working-with-core-data.html
index 4c6f1dcfe..5db00a5d4 100644
--- a/docs/working-with-core-data.html
+++ b/docs/working-with-core-data.html
@@ -381,7 +381,7 @@ 
Reacting to Core Da
           
         
         
       
diff --git a/docs/working-with-uicollectionview.html b/docs/working-with-uicollectionview.html
index 3931b778b..b1c5357c4 100644
--- a/docs/working-with-uicollectionview.html
+++ b/docs/working-with-uicollectionview.html
@@ -295,7 +295,7 @@ 
Performance