Update documentation. #113
Conversation
Documentation/Basics.md
Outdated
| # Basic Usage # | ||
|
|
||
| Let's say you have an endpoint, `GET https://www.example.com/comments/1`, that returns the following JSON: | ||
| Let's say we have an endpoint, `https://raw.githubusercontent.com/thoughtbot/Swish/master/Documentation/example.json` |
There was a problem hiding this comment.
Should we leave GET in here?
Documentation/Basics.md
Outdated
| "commentText": "Pretty good. Pret-ty pre-ty pre-ty good.", | ||
| "username": "LarryDavid" | ||
| } | ||
| ``` | ||
|
|
||
| We'll model this with the following struct, and implement Argo's `Decodable` protocol to tell it how to deal with JSON: | ||
| We will model the data with the following struct, | ||
| and implement the `Codable` protocol so we can |
Documentation/Basics.md
Outdated
| } | ||
| ``` | ||
|
|
||
| We can then use the Swish's default `APIClient` to make the request: | ||
| We can then use the Swish's default APIClient to make the request: |
There was a problem hiding this comment.
Do you think it makes sense to leave the backticks in here?
Documentation/Basics.md
Outdated
| func build() -> URLRequest { | ||
| let url = URL(string: "https://raw.githubusercontent.com/thoughtbot/Swish/master/Documentation/example.json")! | ||
| return URLRequest(url: url) | ||
| } |
There was a problem hiding this comment.
Do you think it's necessary to reindent these examples?
README.md
Outdated
| | 2.X | 1.X | | ||
| | Swift Version | Swish Version | | ||
| | ------------- | ------------ | | ||
| | 4.X | >= 2.0.3 | |
There was a problem hiding this comment.
Should we bump the major version for this change?
|
|
||
| PlaygroundPage.current.needsIndefiniteExecution = true | ||
|
|
||
| // Let's say we have an endpoint, https://raw.githubusercontent.com/thoughtbot/Swish/master/Documentation/example.json |
There was a problem hiding this comment.
Would it be possible to use playground markup instead of regular comments? Or does it automatically render these as Markdown?
Documentation/Basics.md
Outdated
| <*> j <| "commentText" | ||
| <*> j <| "username" | ||
| enum CodingKeys: String, CodingKey { | ||
| case id = "id" |
There was a problem hiding this comment.
FWIW, you can leave off the explicit = "id" if the string value is the same as the case name. (Same goes for username below.)
README.md
Outdated
|
|
||
| You can see an example of Swish in action via the included `SwishExamples.playground`. | ||
|
|
||
| To use that, clone this repository and run `carthage bootstrap`. When that |
There was a problem hiding this comment.
Carthage used to build for all platforms by default — if this is still the case, could we add --platform iOS to match the platform the playground targets?
| struct CommentRequest: Request { | ||
| typealias ResponseObject = Comment | ||
|
|
||
|
|
- Documentation/Basics.md - Added SwishExamples.playground playground file, with the contents of Basics.md
sidraval
force-pushed
the
sr-update-documentation
branch
from
f064fff
to
8c4757f
Compare
Documentation/Basics.mdto include the removal of Argo, and working examples viaCodable.SwishExamples.playgroundthat contains the code inDocumentation/Basics.md.README.mdwith instructions on how to use it.If you checkout this branch, the URL in
SwishExamples.playgroundneeds to be set tohttps://raw.githubusercontent.com/thoughtbot/Swish/sr-update-documentation/Documentation/example.jsonfor the example to work; the URL that is in there now will work once this branch is merged to master.