Update 'Style Guide'

Sasha Koshka 2022-09-01 20:05:48 +00:00
parent 9d07db3673
commit ff3e494804

@ -1,7 +1,7 @@
# Comments
## Documentation Comments
Before each thing that has package-level scope, whether it is public or private, there must be a descriptive documentation before it. These serve as documentation. In accordance with how Go documentation comments are conventionally written, they must:
Before each thing that has package-level scope, whether it is public or private, there must be a descriptive comment directly above it. These serve as documentation. In accordance with how Go documentation comments are conventionally written, they must:
- Start with the thing's name
- If it's a function, focus on explaining *what* the functions does, not how it does it