Skip to content

Commit

Permalink
Removing link for parameter doc syntax (#15)
Browse files Browse the repository at this point in the history
The linked URL to Apple documentation shows a style that we are choosing not to use. Since, we have an example and already link to the general Markup documentation, I have removed the specific parameter syntax one.
  • Loading branch information
drumnkyle authored and cezarywojcik committed Apr 13, 2017
1 parent f1da7a9 commit 54483bb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -961,7 +961,7 @@ Guidelines:

* **4.1.3** Do not prefix each additional line with a `*`.

* **4.1.4** Use the new `- parameter` syntax as opposed to the old `:param:` syntax (make sure to use lower case `parameter` and not `Parameter`). Option-click on a method you wrote to make sure the quick help looks correct. See [the documentation on Swift Markup](https://developer.apple.com/library/watchos/documentation/Xcode/Reference/xcode_markup_formatting_ref/) for more details on how this is formatted.
* **4.1.4** Use the new `- parameter` syntax as opposed to the old `:param:` syntax (make sure to use lower case `parameter` and not `Parameter`). Option-click on a method you wrote to make sure the quick help looks correct.

```swift
class Human {
Expand Down

0 comments on commit 54483bb

Please sign in to comment.