diff --git a/.github/workflows/ios-tests.yml b/.github/workflows/ios-tests.yml index 51148bab..04a5cca1 100644 --- a/.github/workflows/ios-tests.yml +++ b/.github/workflows/ios-tests.yml @@ -11,7 +11,6 @@ jobs: runs-on: macos-latest steps: - uses: actions/checkout@v3 - - run: cd apps/ios && bundle install # may be able to skip this if we don't need fastlane - name: Build run: xcodebuild build-for-testing -workspace apps/ios/GuideDogs.xcworkspace -scheme Soundscape -destination 'platform=iOS Simulator,name=iPhone 13' - name: Test diff --git a/apps/ios/GuideDogs/Code/Data/Authored Activities/AuthoredActivityContent.swift b/apps/ios/GuideDogs/Code/Data/Authored Activities/AuthoredActivityContent.swift index e288a194..d829cb01 100644 --- a/apps/ios/GuideDogs/Code/Data/Authored Activities/AuthoredActivityContent.swift +++ b/apps/ios/GuideDogs/Code/Data/Authored Activities/AuthoredActivityContent.swift @@ -177,9 +177,8 @@ extension AuthoredActivityContent { /// Parses a custom GPX file with the data for an adaptive sports event. /// - /// - Parameter url: URL for downloading the GPX data - /// - Throws: SharedContentError if the file cannot be parsed (or required data is missing) - /// - Returns: An AdaptiveSportsEvent struct + /// - Parameter gpx: A parsed GPX file + /// - Returns: An ``AuthoredActivityContent``, or `nil` if parsing failed or required properties were missing. Currently, waypoints or POIs may be skipped if they lack coordinate data. static func parse(gpx: GPXRoot) -> AuthoredActivityContent? { guard let metadata = gpx.metadata else { return nil @@ -276,10 +275,10 @@ extension AuthoredActivityContent { } } - /// Parses a list of GPXWaypoints into POIWaypoints and AnnotationWaypoints. + /// Parses a list of ``GPXWaypoint``s into ``ActivityWaypoint``s /// - /// - Parameter waypoints: an array of GPXWaypoints - /// - Returns: an array of POIWaypoints and an array of AnnotationWaypoints + /// - Parameter waypoints: an array of ``GPXWaypoint``s + /// - Returns: an array of ``ActivityWaypoint``s including annotation data (if applicable) private static func waypoints(from waypoints: [GPXWaypoint]) -> [ActivityWaypoint] { let imageMimeTypes = Set(["image/jpeg", "image/jpg", "image/png"]) let audioMimeTypes = Set(["audio/mpeg", "audio/x-m4a"]) diff --git a/docs/Client.md b/docs/Client.md index afcb8adc..fff9ed58 100644 --- a/docs/Client.md +++ b/docs/Client.md @@ -3,8 +3,8 @@ The Xcode project can be found in [this folder](../apps/ios/). Instructions on how to setup your development environment, build and -run the Soundscape iOS app can be found in the iOS client [onboarding -documentation](./ios-client/onboarding.md). +run the Soundscape iOS app can be found in the iOS client +[onboarding documentation](./ios-client/onboarding.md). Additional useful instructions for development can be found in the [iOS client documents Folder](./ios-client). diff --git a/docs/ios-client/onboarding.md b/docs/ios-client/onboarding.md index 5a2229a3..d57874c5 100644 --- a/docs/ios-client/onboarding.md +++ b/docs/ios-client/onboarding.md @@ -24,14 +24,13 @@ Open Xcode and you should be prompted with installing the command line tools, or xcode-select --install ``` -## Install Ruby +## Install Fastlane (optional) -_Note:_ while macOS comes with a version of Ruby installed, you should install and use a non-system [Ruby](https://www.ruby-lang.org/) -using a version manager like [RVM](https://rvm.io/) +Installing Fastlane requires a [Ruby](https://www.ruby-lang.org/) installation. -## Install Fastlane (optional) +> __Note:__ while macOS comes with a version of Ruby installed, you should install and use a non-system [Ruby](https://www.ruby-lang.org/) using a version manager like [RVM](https://rvm.io/) -In the iOS project folder, run the following command to install the dependencies from the `Gemfile`: +In the iOS project folder `apps/ios`, run the following command to install the dependencies from the `Gemfile`: ```sh bundle install