Fixing docs #1
Open
Fixing docs #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
December 6, 2017 13:23
Some syntax changes (highlighting/capatilisation), code fixes and additional info added
helenmasters
reviewed
Dec 7, 2017
| pod install | ||
| ``` | ||
| 6. Open the FoodTracker Application in Xcode | ||
| ``` |
There was a problem hiding this comment.
Could you make this Application lower case too?
helenmasters
reviewed
Dec 7, 2017
| This Xcode workspace contains the food tracker mobile app, which can be run by clicking the play button. | ||
| This Xcode workspace contains the FoodTracker mobile app, which can be run by clicking the play button. | ||
|
|
||
| ## Connecting A PostgreSQL Database |
There was a problem hiding this comment.
Can you make the A lower case to match the title below?
helenmasters
reviewed
Dec 7, 2017
README.md
Outdated
| 6. Type `\q` and then press ENTER to quit `psql`. | ||
|
|
||
| ### Adding Swift-Kuery dependencies to your server | ||
| [Swift-Kuery](https://github.com/IBM-Swift/Swift-Kuery) is a database abstraction layer, it works alongside a specific database library, such as [Swift-Kuery-PostgreSQL](https://github.com/IBM-Swift/Swift-Kuery-PostgreSQL), to allow a user to easily query a SQL database in Swift. These two libraries are added to our Package.swift file, so the Server can access them. |
There was a problem hiding this comment.
Package.swift here should have back-ticks around it.
helenmasters
reviewed
Dec 7, 2017
README.md
Outdated
| To work with the meals table in the database, Swift-Kuery requires a matching class. We will now create a `Meals` class to match the meals table we created earlier in PostgreSQL. | ||
|
|
||
| 1. Open your `Sources > Application > Meal.swift` file | ||
| 1. In Xocde, open your `Sources > Application > Meal.swift` file. |
helenmasters
reviewed
Dec 7, 2017
| import SwiftKueryPostgreSQL | ||
| ``` | ||
| 6. Inside the `App` class create a `Meals` table object by inserting the line: | ||
| 6. Inside the `App` class create an instance of the `Meals` table object by inserting the following line: |
There was a problem hiding this comment.
Line 150 needs changing (sorry it isn't this line)... it is "We will now connect to our server to the PostgreSQL database. " there are too many to's!
|
@tunniclm I believe that you're going to do a technical review on this code for Andy. Please can you answer Alex's question about whether we need to add a license as this tutorial actually contains code? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Some syntax changes (highlighting/capatilisation), code fixes and additional info added. Have also added screenshot to help with Xcode scheme changes.
Do we need to add a license (and the respective badge to the header)? Also, haven't added the "Mac OS" badge to the header, but might also want to put that in as tutorial is only for Mac?