Skip to content

Commit 2c61c91

Browse files
authored
minor fixes for the sake of consistency
1 parent 1bd044a commit 2c61c91

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ let myValue = 20 + (30 / 2) * 3
9595
if 1 + 1 == 3 {
9696
fatalError("The universe is broken.")
9797
}
98-
func pancake() -> Pancake {
98+
func pancake(with syrup: Syrup) -> Pancake {
9999
/* ... */
100100
}
101101
```
@@ -947,7 +947,7 @@ guard let thingOne = thingOne else { return }
947947

948948
### 4.1 Documentation
949949

950-
If a function is more complicated than a simple O(1) operation, you should generally consider adding a doc comment for the function since there could be some information that the method signature does not make immediately obvious (A very useful plugin to do this [called VVDocumenter can be found here](https://github.com/onevcat/VVDocumenter-Xcode)). If there are any quirks to the way that something was implemented, whether technically interesting, tricky, not obvious, etc., this should be documented. Documentation should be added for complex classes/structs/enums/protocols and properties. All `public` functions/classes/properties/constants/structs/enums/protocols/etc. should be documented as well (provided, again, that their signature/name does not make their meaning/functionality immediately obvious).
950+
If a function is more complicated than a simple O(1) operation, you should generally consider adding a doc comment for the function since there could be some information that the method signature does not make immediately obvious. If there are any quirks to the way that something was implemented, whether technically interesting, tricky, not obvious, etc., this should be documented. Documentation should be added for complex classes/structs/enums/protocols and properties. All `public` functions/classes/properties/constants/structs/enums/protocols/etc. should be documented as well (provided, again, that their signature/name does not make their meaning/functionality immediately obvious).
951951

952952
After writing a doc comment, you should option click the function/property/class/etc. to make sure that everything is formatted correctly.
953953

0 commit comments

Comments
 (0)