How To Use

Here is the layout that would be what I am shooting for:

#TITLE HERE ##Initializing class info ####All variables that need initializing (no need for a table on this one )

• varOne: used for ____

##Any Special Enums/Structs ###Struct/Enum Name ####Variables

Name	Brief Description
kSouth	Returns the south variable and is used with compass methods

##All of the public methods ###Method Name Description: Lorem de inor.

Inputs:

• (int, int) -> explain
• (String) -> explain *() -> explain

Output(s): int -> use int blah(*int) -> explain

##All of the private methods ###Method Name Description: Lorem de inor.

Inputs:

• (int, int) -> explain
• (String) -> explain *() -> explain

Output(s): int -> use int blah(*int) -> explain

##Variables Please just copy the table by editing this page

Name	Type	Public	Use	Brief Description
test1	Int	Private	blahMethod	A simple variable to show how many blahs to return.
test2	Bool	Public	errorMethod	A method that will always throw an error.

If you would like to see the documentation on making tables, they are here: Tables

Code Standardization

I think it is important to have some standardization between our code. That way it is easier for us to find variables and the like without looking at the classes wiki or it's code while coding. So here are some simple things. Just because the code should currently follow these standards, we use raywenderlich.com's Swift Style Guide. This style guide can be found here.

Also, When pushing code, or pulling to master, all code gets built by Travis CI. That way we can know when code stopped working. The best way to know if your code works is to build it with PlatformIO and upload it with GitHub Desktop.