Wording updates

Author: fulldecent

CHANGELOG.md

@@ -48,7 +48,7 @@ Released on 2017-05-31.
 
 #### Changed
 - Now using ranges in the API where appropriate
-  - Added by [William Entriken](https://github.com/fulldecent) in Regards to Issue
+  - Added by [William Entriken](https://github.com/fulldecent) in regards to issue
   [#76](https://github.com/fulldecent/FDWaveformView/issues/86).
 
 #### Fixed
@@ -65,7 +65,7 @@ Released on 2017-05-03.
 #### Added
 - Improved accuracy of waveform rendering
   - Added by [Kip Nicol](https://github.com/ospr)
-- Added support for rendering waveform images outside of a view (See `FDWaveformRenderOperation`)
+- Added support for rendering waveform images outside of view (See `FDWaveformRenderOperation`)
   - Added by [Kip Nicol](https://github.com/ospr)
 - Added support for rendering linear waveforms
   - Added by [Kip Nicol](https://github.com/ospr)
@@ -94,7 +94,7 @@ Released on 2017-04-15.
 #### Added
 - Improved example app to include more options
   - Added by [William Entriken](https://github.com/fulldecent)
-- Allow animation for changes to zoom
+- Allowed animation for changes to zoom
   - Added by [William Entriken](https://github.com/fulldecent)
 
 #### Fixed
@@ -103,7 +103,7 @@ Released on 2017-04-15.
 - Fixed waveform rendering for large audio files
   - Added by [Kip Nicol](https://github.com/ospr)
 - Fixed crash with quick load time
-  - Added by [William Entriken](https://github.com/fulldecent) in Regards to Issue
+  - Added by [William Entriken](https://github.com/fulldecent) in regards to issue
   [#76](https://github.com/fulldecent/FDWaveformView/issues/76).
 
 ---
@@ -112,9 +112,9 @@ Released on 2017-04-15.
 Released on 2017-02-16.
 
 #### Added
-- Allow scrubbing independantly of scrolling
+- Allowed scrubbing independantly of scrolling
   - Added by [Doug Earnshaw](https://github.com/pixlwave)
-- Tidy up Swift 3.0 conversion, remove some forced unwraps & generally make more Swifty
+- Tidied up Swift 3.0 conversion, removed some forced unwraps & generally made more swifty
   - Added by [Doug Earnshaw](https://github.com/pixlwave)
 
 ---
@@ -125,7 +125,7 @@ Released on 2016-09-27.
 #### Added
 - Automated CocoaPods Quality Indexes testing
   - Added by [Hayden Holligan](https://github.com/haydenholligan)
-- Use GPU to process waveforms
+- Used GPU to process waveforms
   - Added by [Hayden Holligan](https://github.com/haydenholligan)
 
 ---
@@ -135,7 +135,7 @@ Released on 2016-09-02.
 
 #### Fixed
 - Corrected rendering, fixed typo
-  - Added by [William Entriken](https://github.com/fulldecent) in Regards to Issue
+  - Added by [William Entriken](https://github.com/fulldecent) in regards to issue
   [#62](https://github.com/fulldecent/FDWaveformView/issues/62).
 
 ---
@@ -145,7 +145,7 @@ Released on 2016-08-02.
 
 #### Fixed
 - Fixed Podspec for Swift files
-  - Added by [William Entriken](https://github.com/fulldecent) in Regards to Issue
+  - Added by [William Entriken](https://github.com/fulldecent) in regards to issue
   [#61](https://github.com/fulldecent/FDWaveformView/issues/61).
 
 ---
@@ -155,16 +155,16 @@ Released on 2016-06-27.
 
 #### Added
 - Full API documentation
-  - Added by [William Entriken](https://github.com/fulldecent) in Regards to Issue
+  - Added by [William Entriken](https://github.com/fulldecent) in regards to issue
   [#53](https://github.com/fulldecent/FDWaveformView/issues/53).
 - Release process documentation
-  - Added by [William Entriken](https://github.com/fulldecent) in Regards to Issue
+  - Added by [William Entriken](https://github.com/fulldecent) in regards to issue
   [#57](https://github.com/fulldecent/FDWaveformView/issues/57).
-- Change Log
-  - Added by [William Entriken](https://github.com/fulldecent) in Regards to Issue
+- Changed Log
+  - Added by [William Entriken](https://github.com/fulldecent) in regards to issue
   [#54](https://github.com/fulldecent/FDWaveformView/issues/54).
 - Swift Package Manager support
-  - Added by [William Entriken](https://github.com/fulldecent) in Regards to Issue
+  - Added by [William Entriken](https://github.com/fulldecent) in regards to issue
   [#52](https://github.com/fulldecent/FDWaveformView/issues/52).
 
 ---
@@ -182,11 +182,11 @@ Released on 2016-04-10.
 Released on 2016-03-29.
 
 #### Added
-- Separate scrolling and pinching options
+- Separated scrolling and pinching options
   - Added by [Rudy Mutter](https://github.com/rmutter)
 
 #### Updated
-- Uses recommended CocoPods project format
+- Used recommended CocoPods project format
   - Added by [William Entriken](https://github.com/fulldecent)
 
 #### Fixed

README.md

@@ -38,7 +38,7 @@ self.waveform.progressSamples = self.waveform.totalSamples / 2
 <img src="https://i.imgur.com/fRrHiRP.png" width=250>
 </p>
 
-**Zoom in** to show only part of the waveform, of course, zooming in will smoothly rerender to show progressively more detail:
+**Zoom in** to show only part of the waveform, of course, zooming in will smoothly re-render to show progressively more detail:
 
 ```swift
 self.waveform.zoomStartSamples = 0
@@ -87,4 +87,4 @@ Add this to your project using Swift Package Manager. In Xcode that is simply: F
 
 ## Contributing
 
-This project's layout is based on https://github.com/fulldecent/swift4-module-template If you would like to change the layout, please change that project FIRST. Also you may appreciate that project has "recipes" -- you don't just change code you explain why you are doing things. As a maintainer this makes my job MUCH simpler. In a similar respect, if you are introducing non-minor changes, it will be VERY helpful if you could please reference to another project (like AlamoFire) that has seen and discussed the types of design challenges you are touching.) Thanks again and we all really do appreciate your contributions.
+This project's layout is based on https://github.com/fulldecent/swift4-module-template If you would like to change the layout, please change that project FIRST. Also you may appreciate that project has "recipes" -- you don't just change code, you also explain why you are doing things. As a maintainer this makes my job MUCH simpler. In a similar respect, if you are introducing non-minor changes, it will be VERY helpful if you could please reference to another project (like AlamoFire) that has seen and discussed the types of design challenges you are touching.) Thanks again and we all really do appreciate your contributions.

Sources/FDWaveformView/FDWaveformRenderOperation.swift

@@ -141,7 +141,7 @@ final public class FDWaveformRenderOperation: Operation {
         finish(with: image)
     }
 
-    /// Read the asset and create create a lower resolution set of samples
+    /// Read the asset and create a lower resolution set of samples
     func sliceAsset(withRange slice: CountableRange<Int>, andDownsampleTo targetSamples: Int) -> (samples: [CGFloat], sampleMax: CGFloat)? {
         guard !isCancelled else { return nil }
 
@@ -181,7 +181,7 @@ final public class FDWaveformRenderOperation: Operation {
 
         // 16-bit samples
         reader.startReading()
-        defer { reader.cancelReading() } // Cancel reading if we exit early if operation is cancelled
+        defer { reader.cancelReading() } // Cancel reading if we exit early or if operation is cancelled
 
         while reader.status == .reading {
             guard !isCancelled else { return nil }
@@ -213,7 +213,7 @@ final public class FDWaveformRenderOperation: Operation {
             //print("Status: \(reader.status)")
         }
 
-        // Process the remaining samples at the end which didn't fit into samplesPerPixel
+        // Process the remaining samples that did not fit into samplesPerPixel at the end
         let samplesToProcess = sampleBuffer.count / MemoryLayout<Int16>.size
         if samplesToProcess > 0 {
             guard !isCancelled else { return nil }
@@ -233,7 +233,7 @@ final public class FDWaveformRenderOperation: Operation {
         }
 
         // if (reader.status == AVAssetReaderStatusFailed || reader.status == AVAssetReaderStatusUnknown)
-        // Something went wrong. Handle it, or not depending on if you can get above to work
+        // Something went wrong. Handle it or do not, depending on if you can get above to work
         if reader.status == .completed || true{
             return (outputSamples, sampleMax)
         } else {

Sources/FDWaveformView/FDWaveformView.swift

@@ -123,17 +123,17 @@ open class FDWaveformView: UIView {
     /// If this portion is not available then a re-render will be performed
     private var horizontalBleedAllowed = 0.1 ... 3.0
 
-    /// The number of horizontal pixels to render per visible pixel on the screen (for antialiasing)
+    /// The number of horizontal pixels to render per visible pixel on the screen (for anti-aliasing)
     private var horizontalOverdrawTarget = 3.0
 
-    /// The required number of horizontal pixels to render per visible pixel on the screen (for antialiasing)
+    /// The required number of horizontal pixels to render per visible pixel on the screen (for anti-aliasing)
     /// If this number is not available then a re-render will be performed
     private var horizontalOverdrawAllowed = 1.5 ... 5.0
 
-    /// The number of vertical pixels to render per visible pixel on the screen (for antialiasing)
+    /// The number of vertical pixels to render per visible pixel on the screen (for anti-aliasing)
     private var verticalOverdrawTarget = 2.0
 
-    /// The required number of vertical pixels to render per visible pixel on the screen (for antialiasing)
+    /// The required number of vertical pixels to render per visible pixel on the screen (for anti-aliasing)
     /// If this number is not available then a re-render will be performed
     private var verticalOverdrawAllowed = 1.0 ... 3.0
 
@@ -189,7 +189,7 @@ open class FDWaveformView: UIView {
         return window?.screen.scale ?? UIScreen.main.scale
     }
 
-    /// Waveform type for rending waveforms
+    /// Waveform type for rendering waveforms
     //TODO: make this public after reconciling FDWaveformView.WaveformType and FDWaveformType
     var waveformRenderType: FDWaveformType {
         get {
@@ -240,7 +240,7 @@ open class FDWaveformView: UIView {
     }
 
     /// Indicates the gesture begun lastly.
-    /// This helps to determine which of continuous interaction should be active, pinching or panning.
+    /// This helps to determine which of the continuous interactions should be active, pinching or panning.
     /// pinchRecognizer
     fileprivate var firstGesture = PressType.none
 
@@ -290,7 +290,7 @@ open class FDWaveformView: UIView {
         inProgressWaveformRenderOperation?.cancel()
     }
 
-    /// If the cached waveform or in progress waveform is insufficient for the current frame
+    /// If the cached waveform or in-progress waveform is insufficient for the current frame
     fileprivate func cacheStatus() -> CacheStatus {
         guard !renderForCurrentAssetFailed else { return .notDirty(cancelInProgressRenderOperation: true) }
 
@@ -502,13 +502,13 @@ extension FDWaveformView: UIGestureRecognizerDelegate {
         case .began:
             if firstGesture == .none {
                 // Set firstGesture to .pinch only if panning gesture is not active.
-                // This enables the user to repetitive pan and zoom action.
-                // If we set firstGesture to .pinch in any state then the user became unable
-                // to panning until they release all of fingers from the view.
+                // This enables the user to repetitively pan and zoom action.
+                // If we set firstGesture to .pinch in any state then the user becomes unable
+                // to pan until they release all fingers from the view.
                 firstGesture = .pinch
             }
         case .ended, .cancelled:
-            // This happens only if panning had not started.
+            // This happens only if panning has not started.
             firstGesture = .none
         default:
             break
@@ -527,7 +527,7 @@ extension FDWaveformView: UIGestureRecognizerDelegate {
     @objc func handlePanGesture(_ recognizer: UIPanGestureRecognizer) {
         guard !zoomSamples.isEmpty else { return }
 
-        // This method is called even the user began with pinching.
+        // This method is called even if the user began with pinching.
 
         switch recognizer.state {
         case .began:
@@ -596,13 +596,13 @@ extension FDWaveformView: UIGestureRecognizerDelegate {
     /// An audio file was loaded
     @objc optional func waveformViewDidLoad(_ waveformView: FDWaveformView)
 
-    /// The panning gesture did begin
+    /// The panning gesture began
     @objc optional func waveformDidBeginPanning(_ waveformView: FDWaveformView)
 
-    /// The panning gesture did end
+    /// The panning gesture ended
     @objc optional func waveformDidEndPanning(_ waveformView: FDWaveformView)
 
-    /// The scrubbing gesture did end
+    /// The scrubbing gesture ended
     @objc optional func waveformDidEndScrubbing(_ waveformView: FDWaveformView)
 }
 

Tests/CheckCocoaPodsQualityIndexes.rb

@@ -5,7 +5,7 @@
 # by William Entriken, version 1.0.1
 # Part of https://github.com/fulldecent/swift3-module-template
 #
-# The validates that all controllable quality metrics receive maximum score
+# This validates that all controllable quality metrics receive maximum score
 # from CocoaPods's scoring quality algorithm
 #
 # Usage: ruby CheckCocoaPodsQualityIndexes.rb PODNAME

iOS Example/Sources/ViewController.swift

@@ -136,7 +136,7 @@ class ViewController: UIViewController {
         super.viewDidLoad()
         let thisBundle = Bundle(for: type(of: self))
         let url = thisBundle.url(forResource: "Submarine", withExtension: "aiff")
-        // Animate the waveform view in when it is rendered
+        // Animate the waveform view when it is rendered
         waveform.delegate = self
         waveform.alpha = 0.0
         waveform.audioURL = url