Skip to content

Commit 8ec2513

Browse files
committed
restore Public Functions section
good catch @wpalmeri
1 parent c511043 commit 8ec2513

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,24 @@ Rules to follow for all functions:
173173
* Always put a space after `,` in function signatures.
174174

175175
## Public Functions
176+
All public functions and methods, including those inside `object`s must have:
177+
178+
* A return type
179+
* Scaladoc including a function overview, information on parameters, and information on the return value. See the Scaladoc section for more details.
180+
181+
Here is a complete example of a function inside of an `object`.
182+
183+
```scala
184+
object MyObject {
185+
/**
186+
* returns the static integer 123
187+
* @return the number 123
188+
*/
189+
def myFunction: Int = {
190+
123
191+
}
192+
}
193+
```
176194

177195
### Parameter Lists
178196

0 commit comments

Comments
 (0)