API: Name and comment changes for remove_index

Co-authored-by: Jim Turner <github@turner.link>

Author: bluss

src/impl_methods.rs

@@ -2449,15 +2449,15 @@ where
     /// Decreases the length of `axis` by one.
     ///
     /// ***Panics** if `axis` or `index` is out of bounds.
-    pub fn shift_remove_index(&mut self, axis: Axis, index: usize)
+    pub fn remove_index(&mut self, axis: Axis, index: usize)
     where
         S: DataOwned + DataMut,
     {
-        // TODO: It's possible to choose to shift the elment to the front or the back here,
+        // TODO: It's possible to choose to shift the element to the front or the back here,
         // whichever is closer.
         let (_, mut tail) = self.view_mut().split_at(axis, index);
-        // shift elements to the back
-        // use swap to keep all elements initialized (as required by owned storage)
+        // shift elements to the front
+        // use swapping to keep all elements initialized (as required by owned storage)
         Zip::from(tail.lanes_mut(axis)).for_each(|mut lane| {
             let mut lane_iter = lane.iter_mut();
             let mut dst = if let Some(dst) = lane_iter.next() { dst } else { return };

tests/array.rs

@@ -2399,13 +2399,13 @@ mod array_cow_tests {
 }
 
 #[test]
-fn test_shift_remove() {
+fn test_remove_index() {
     let mut a = arr2(&[[1, 2, 3],
                        [4, 5, 6],
                        [7, 8, 9],
                        [10,11,12]]);
-    a.shift_remove_index(Axis(0), 1);
-    a.shift_remove_index(Axis(1), 2);
+    a.remove_index(Axis(0), 1);
+    a.remove_index(Axis(1), 2);
     assert_eq!(a.shape(), &[3, 2]);
     assert_eq!(a,
         array![[1, 2],
@@ -2417,22 +2417,22 @@ fn test_shift_remove() {
                        [7, 8, 9],
                        [10,11,12]]);
     a.invert_axis(Axis(0));
-    a.shift_remove_index(Axis(0), 1);
-    a.shift_remove_index(Axis(1), 2);
+    a.remove_index(Axis(0), 1);
+    a.remove_index(Axis(1), 2);
     assert_eq!(a.shape(), &[3, 2]);
     assert_eq!(a,
         array![[10,11],
                [4, 5],
                [1, 2]]);
 
-    a.shift_remove_index(Axis(1), 1);
+    a.remove_index(Axis(1), 1);
 
     assert_eq!(a.shape(), &[3, 1]);
     assert_eq!(a,
         array![[10],
                [4],
                [1]]);
-    a.shift_remove_index(Axis(1), 0);
+    a.remove_index(Axis(1), 0);
     assert_eq!(a.shape(), &[3, 0]);
     assert_eq!(a,
         array![[],