Skip to content

Commit

Permalink
Merge pull request #54 from chrs1885/feature/52-remove-handicaps-feature
Browse files Browse the repository at this point in the history
Remove Handicaps feature
  • Loading branch information
chrs1885 authored Mar 16, 2021
2 parents 8a3a913 + c9bef0a commit c097808
Show file tree
Hide file tree
Showing 34 changed files with 2,128 additions and 3,865 deletions.
3 changes: 0 additions & 3 deletions Documentation/Reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,11 @@ This Reference Documentation has been generated with

- [Capable](structs/Capable.md)
- [FeatureStatus](structs/FeatureStatus.md)
- [Handicap](structs/Handicap.md)
- [HandicapStatus](structs/HandicapStatus.md)

## Enums

- [CapableFeature](enums/CapableFeature.md)
- [ConformanceLevel](enums/ConformanceLevel.md)
- [HandicapEnabledMode](enums/HandicapEnabledMode.md)
- [ImageArea](enums/ImageArea.md)

## Extensions
Expand Down
23 changes: 2 additions & 21 deletions Documentation/Reference/extensions/Capable.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
public var statusMap: [String: String]
```

> The `statusMap` property returns a dictionary of all `CapableFeature`s or `Handicap`s , that the Capable instance has been initialized with along with their current statuses. This object is compatible with most analytic SDKs such as **Fabric Answers**, **Firebase Analytics**, **AppCenter Analytics**, or **HockeyApp**.
> The `statusMap` property returns a dictionary of all `CapableFeature`s, that the Capable instance has been initialized with along with their current statuses. This object is compatible with most analytic SDKs such as **Fabric Answers**, **Firebase Analytics**, **AppCenter Analytics**, or **HockeyApp**.
> While most entries can only have a status set to **enabled** or **disabled**, the `.largerText` feature offers the font scale set by the user.
## Methods
Expand All @@ -30,23 +30,4 @@ public func isFeatureEnabled(feature: CapableFeature) -> Bool

| Name | Description |
| ---- | ----------- |
| feature | The feature of interest. |

### `isHandicapEnabled(handicapName:)`

```swift
public func isHandicapEnabled(handicapName: String) -> Bool
```

> Provides information regarding the current status of a provided `Handicap`.
>
> - Parameters:
> - handicapName: The name of the requested of `Handicap`.
>
> - Returns: `true` if the given feature has been enabled, otherwise `false`. Note that the status depends on the `Handicap`'s `enabledIf` value (see `HandicapEnabledMode`).
#### Parameters

| Name | Description |
| ---- | ----------- |
| handicapName | The name of the requested of `Handicap`. |
| feature | The feature of interest. |
19 changes: 1 addition & 18 deletions Documentation/Reference/structs/Capable.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,4 @@ public init(withFeatures features: [CapableFeature] = CapableFeature.allCases)

| Name | Description |
| ---- | ----------- |
| features | An optional array containing the features of interest. This will default to all features available on the current platform. |

### `init(withHandicaps:)`

```swift
public init(withHandicaps handicaps: [Handicap])
```

> Initializes the framework instance with a set of `Handicap`s.
>
> - Parameters:
> - handicaps: An optional array containing the `Handicaps`s specified by the caller.

#### Parameters

| Name | Description |
| ---- | ----------- |
| handicaps | An optional array containing the `Handicaps`s specified by the caller. |
| features | An optional array containing the features of interest. This will default to all features available on the current platform. |
54 changes: 0 additions & 54 deletions Example/Example.xcodeproj/project.pbxproj

Large diffs are not rendered by default.

18 changes: 9 additions & 9 deletions Example/Podfile.lock
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
PODS:
- Capable (1.1.3):
- Capable/Colors (= 1.1.3)
- Capable/Features (= 1.1.3)
- Capable/Fonts (= 1.1.3)
- Capable/Colors (1.1.3)
- Capable/Features (1.1.3)
- Capable/Fonts (1.1.3)
- Capable (1.1.4):
- Capable/Colors (= 1.1.4)
- Capable/Features (= 1.1.4)
- Capable/Fonts (= 1.1.4)
- Capable/Colors (1.1.4)
- Capable/Features (1.1.4)
- Capable/Fonts (1.1.4)
- Nimble (8.0.4)
- Quick (2.2.0)
- SheetyColors (1.0.1):
Expand All @@ -28,11 +28,11 @@ EXTERNAL SOURCES:
:path: "../"

SPEC CHECKSUMS:
Capable: a0fa984888106d458496147719928ffc3dfdefd2
Capable: 9f420f2a80a12144814ea2f0ba196516a0827ca1
Nimble: 18d5360282923225d62b09d781f63abc1a0111fc
Quick: 7fb19e13be07b5dfb3b90d4f9824c855a11af40e
SheetyColors: ae8c3a5d04d310e8e2d08e4aa0bd543519d02252

PODFILE CHECKSUM: 4be5f3d8c8dceba64f29d52556419c2c3a677413

COCOAPODS: 1.8.4
COCOAPODS: 1.9.3
4,078 changes: 2,014 additions & 2,064 deletions Example/Pods/Pods.xcodeproj/project.pbxproj

Large diffs are not rendered by default.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

143 changes: 0 additions & 143 deletions Example/Source/HandicapViewController.swift

This file was deleted.

Loading

0 comments on commit c097808

Please sign in to comment.