Skip to content

Commit

Permalink
Updated concept docs and the docs (#583)
Browse files Browse the repository at this point in the history
Updated concept docs and the docs
  • Loading branch information
meatball133 authored Oct 31, 2022
1 parent ab1b8c5 commit 95c8373
Show file tree
Hide file tree
Showing 14 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions concepts/arrays/links.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "Apple Swift Documentation: Array"
},
{
"url": "https://docs.swift.org/swift-book/LanguageGuide/CollectionTypes.html#ID107",
"url": "https://docs.swift.org/swift-book/LanguageGuide/CollectionTypes.html#",
"description": "The Swift Language Guide: Collection Types"
}
]
]
2 changes: 1 addition & 1 deletion concepts/default-parameters/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ greeting()
// => "Welcome, guest. Enjoy your 2 night stay."
```

[default-parameter-values]: https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID169
[default-parameter-values]: https://docs.swift.org/swift-book/LanguageGuide/Functions.html#ID169
4 changes: 2 additions & 2 deletions concepts/function-overloading/links.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"description": "Swift.org: Type Aannotations"
},
{
"url": "https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID166",
"url": "https://docs.swift.org/swift-book/LanguageGuide/Functions.html#ID166",
"description": "Swift.org: Argument Labels"
}
]
]
2 changes: 1 addition & 1 deletion concepts/functions/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,5 @@ let twentySix = add(6, and: 7, doubleResult: true)
Within the body of a function, parameters are treated as constants, not variables.

[functions]: https://docs.swift.org/swift-book/LanguageGuide/Functions.html
[argument labels]: https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID166
[argument labels]: https://docs.swift.org/swift-book/LanguageGuide/Functions.html#ID166
[type annotations]: https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID312
4 changes: 2 additions & 2 deletions concepts/importing/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This allows access to all of the types, values, and functionality inside that mo

While they can be placed in the code anywhere before a pice of code that makes use of one the content of module, import statements are usually placed at the beginning of the file that uses them for greater readability.

[argument-parser]: https://github.com/apple/swift-argument-parser
[argument-parser]: https://apple.github.io/swift-argument-parser/documentation/argumentparser/
[network-framework]: https://developer.apple.com/documentation/network
[swifty-beaver]: https://github.com/apple/swift-argument-parser
[swifty-beaver]: https://github.com/SwiftyBeaver/SwiftyBeaver
[apple-foundation]: https://developer.apple.com/documentation/foundation
2 changes: 1 addition & 1 deletion concepts/inout-parameters/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ inoutFunc(&mutVar, &mutVar)
// raises a compiler error: "Inout arguments are not allowed to alias each other"
```

[in-out-parameters]: https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID173
[in-out-parameters]: https://docs.swift.org/swift-book/ReferenceManual/Declarations.html#ID545
4 changes: 2 additions & 2 deletions concepts/loops/links.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[
{
"url": "https://docs.swift.org/swift-book/LanguageGuide/ControlFlow.html",
"url": "https://docs.swift.org/swift-book/LanguageGuide/ControlFlow.html#ID135",
"description": "The Swift Language Guide: Control Transfer"
}
]
]
4 changes: 2 additions & 2 deletions concepts/multiple-return-values/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ In cases where the entire body of a function is a single expression, [the `retur

Note that this applies for all return types, not just multiple-value returns.

[multiple-return-values]: https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID164
[implicit-returns]: https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID607
[multiple-return-values]: https://docs.swift.org/swift-book/LanguageGuide/Functions.html#ID164
[implicit-returns]: https://docs.swift.org/swift-book/LanguageGuide/Functions.html#ID607
2 changes: 1 addition & 1 deletion concepts/nested-functions/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ makeNumber([true, true, false, false, false, true, true])
// => 99
```

[nested-functions]: https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID178
[nested-functions]: https://docs.swift.org/swift-book/LanguageGuide/Functions.html#ID178
2 changes: 1 addition & 1 deletion concepts/numbers/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ let negativeUInt2 = UInt(negative)
// error: Execution was interrupted, reason: EXC_BAD_INSTRUCTION (code=EXC_I386_INVOP, subcode=0x0).
```

[integers]: https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID310
[integers]: https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID317
[floatingpoint]: https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID321
[int]: https://developer.apple.com/documentation/swift/int
[double]: https://developer.apple.com/documentation/swift/double
Expand Down
2 changes: 1 addition & 1 deletion concepts/variadic-parameters/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ When using variadic parameters, Swift has two limitations:
1. Swift only allows functions to have one variadic parameter. It has been decided that this restriction will be removed in a future release of Swift, but it is currently still in place.
2. If a function has parameters that follow the variadic parameter in the definition, the first parameter following the variadic parameter is _required_ to have an argument label.

[variadic-parameters]: https://docs.swift.org/swift-book/LanguageGuide/TheBasics.html#ID171
[variadic-parameters]: https://docs.swift.org/swift-book/LanguageGuide/Functions.html#ID171
2 changes: 1 addition & 1 deletion docs/INSTALLATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Additional versions of Xcode (including the most recent beta) are available at [

All exercises have been tested with Xcode 10.0 using Swift 4.2.

## Linux
## Linux or Windows

The latest release is available on [Swift.org](https://swift.org/download/#releases).

Expand Down
2 changes: 1 addition & 1 deletion docs/LEARNING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ resources can help you get started:

* [Apple Swift Website](http://www.apple.com/swift/)
* [The Swift Programming Language Website](https://swift.org/documentation/)
* [Swift Education](http://swifteducation.github.io/)
* [Swift playground](https://www.apple.com/swift/playgrounds/)
6 changes: 3 additions & 3 deletions docs/TESTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The following instructions are written with the expectation that some readers wi

**macOS users are encouraged to use Xcode.** The Xcode environment provides very detailed error messages compared to those available from the command line.

Exercism uses the [Swift Package Manager](https://github.com/apple/swift-package-manager/tree/master/Documentation) to package files and tests for Swift. Packages provide a complete set of source files that can be compiled and executed from the command line (or from Xcode).
Exercism uses the [Swift Package Manager](https://github.com/apple/swift-package-manager/tree/main/Documentation) to package files and tests for Swift. Packages provide a complete set of source files that can be compiled and executed from the command line (or from Xcode).

To complete an Exercism exercise, you will work primarily with two files:

Expand Down Expand Up @@ -103,11 +103,11 @@ XCTestCase is the XCTest subclass that contains the test's methods and XCTAssert

There is a lot more to learn more about Test Driven Development, XCTAssert Methods and XCTestCase. Unfortunately up-to-date Swift documentation on these topics is short-lived. Although out of date as of when this tutorial was last updated, this list of sources contains useful information:

[Apple's Guide on XCTest](https://developer.apple.com/library/tvos/documentation/DeveloperTools/Conceptual/testing_with_xcode/chapters/02-quick_start.html#//apple_ref/doc/uid/TP40014132-CH2-SW1)
[Apple's Guide on XCTest](https://developer.apple.com/documentation/xctest)

[XCTest​Case / XCTest​Expectation / measure​Block()](http://nshipster.com/xctestcase/)

A list of [Assertions supported in XCTest](http://rshankar.com/assertions-supported-in-xctest/).

[Getting Started with TDD in Swift 3.0](https://medium.com/@ynzc/getting-started-with-tdd-in-swift-2fab3e07204b#.589p6ao6y)
[Getting Started with TDD in Swift 4.0](https://medium.com/@ynzc/getting-started-with-tdd-in-swift-2fab3e07204b#.589p6ao6y)

0 comments on commit 95c8373

Please sign in to comment.