Documentation and formatting updates.

Author: johnnewman-square

Demo/Sources/Demos/Demo Screens/AutoScrollingViewController3.swift

@@ -14,8 +14,8 @@ import BlueprintUI
 import BlueprintUICommonControls
 
 
-final class AutoScrollingViewController3 : UIViewController
-{
+final class AutoScrollingViewController3 : UIViewController {
+    
     let list = ListView()
 
     lazy var insertButton: UIBarButtonItem = {
@@ -48,21 +48,16 @@ final class AutoScrollingViewController3 : UIViewController
 
     override func viewDidLoad() {
         super.viewDidLoad()
-
         updateItems()
     }
 
     private func updateItems() {
-        
-        self.list.configure { list in
+        list.configure { list in
             list.appearance = .demoAppearance
             list.layout = .demoLayout
-
             list.behavior.verticalLayoutGravity = .bottom
-
             list.animation = .fast
-            
-            list += Section("items", items: self.items)
+            list += Section("items", items: items)
 
             list.autoScrollAction = .scrollTo(
                 .item(seekToIdentifier),

ListableUI/Sources/ListView/ListView.swift

@@ -1286,16 +1286,16 @@ public final class ListView : UIView
                     if behavior.verticalLayoutGravity == .bottom {
                         /// Perform a layout to adjust the `contentSize` of the collection view before
                         /// scrolling. This avoids an issue where:
-                        ///   - the list is first appearing with a `bottom` `VerticalLayoutGravity` and a
-                        ///     `scrollToItem(onInsertOf:)` `AutoScrollAction`.
+                        ///   - the list is first appearing with `VerticalLayoutGravity.bottom` and
+                        ///     `AutoScrollAction.scrollToItem(onInsertOf:)` behaviors
                         ///   - the initial set of items in the list trigger the `scrollToItem(onInsertOf:)`
                         ///   - the resulting scroll position isn't at the bottom of the list
                         ///
                         /// Without calling `layoutIfNeeded`, the above scenario will reset the scroll position
                         /// to the bottom, discarding this scroll update. This is because the system will
                         /// asynchronously update the underlying `contentSize` as part of the initial layout,
                         /// moments after this method is executed. The list's `contentSize` is overridden to
-                        /// keep the offset anchored to the bottom when using `bottom` `VerticalLayoutGravity`.
+                        /// keep the offset anchored to the bottom when using `VerticalLayoutGravity.bottom`.
                         collectionView.layoutIfNeeded()
                     }
 

ListableUI/Tests/ListView/ListViewTests.swift

@@ -616,9 +616,7 @@ class ListViewTests: XCTestCase
             var didPerform : [ListScrollPositionInfo] = []
 
             var content = ListProperties.default { list in
-                
                 list.animatesChanges = false
-                
                 list.sections = (1...50).map { sectionID in
                     Section(sectionID) {
                         for itemNumber in 1...20 {
@@ -628,7 +626,6 @@ class ListViewTests: XCTestCase
                 }
 
                 let ID = TestContent.identifier(with: "A")
-                
                 list.autoScrollAction = .scrollTo(
                     .item(ID),
                     onInsertOf: ID,
@@ -694,7 +691,6 @@ class ListViewTests: XCTestCase
             var didPerform : [ListScrollPositionInfo] = []
 
             var content = ListProperties.default { list in
-                
                 list.animatesChanges = false
                 list.behavior.verticalLayoutGravity = .bottom
                 list.sections = (1...50).map { sectionID in
@@ -706,7 +702,6 @@ class ListViewTests: XCTestCase
                 }
 
                 let ID = TestContent.identifier(with: "A")
-                
                 list.autoScrollAction = .scrollTo(
                     .item(ID),
                     onInsertOf: ID,
@@ -782,7 +777,6 @@ class ListViewTests: XCTestCase
             var didPerform : [ListScrollPositionInfo] = []
 
             var content = ListProperties.default { list in
-                
                 list.sections = (1...50).map { sectionID in
                     Section(sectionID) {
                         for itemID in 1...20 {
@@ -792,7 +786,6 @@ class ListViewTests: XCTestCase
                 }
 
                 let ID = TestContent.identifier(with: "A")
-                
                 list.autoScrollAction = .pin(
                     .item(ID),
                     position: .init(position: .bottom),
@@ -806,26 +799,22 @@ class ListViewTests: XCTestCase
 
             show(vc: vc) { vc in
                 vc.list.configure(with: content)
-
                 waitFor { vc.list.updateQueue.isEmpty }
-                
                 XCTAssertEqual(didPerform.count, 0)
 
                 vc.list.configure(with: content)
-
                 waitFor { vc.list.updateQueue.isEmpty }
-                
                 XCTAssertEqual(didPerform.count, 0)
 
                 content.content += Section("new") {
                     TestContent(content: "A")
                 }
 
                 vc.list.configure(with: content)
-                
                 waitFor { vc.list.updateQueue.isEmpty }
-                
                 XCTAssertEqual(didPerform.count, 1)
+                
+                // TODO: Assert that the visible items are correct when using `pin(...)`.
             }
         }
     }