kylefang/stacks-subnets
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-subnets.git synced 2026-01-12 16:53:24 +08:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Reed Rosenbluth <331327+reedrosenbluth@users.noreply.github.com>
Co-authored-by: pavitthrap <paviusa23@gmail.com>
This commit is contained in:
Gregory Coppola
2021-07-28 13:45:50 -05:00
committed by GitHub
parent bf6e555de2
commit 620dd3258a
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTORS.md
View File

@@ -158,12 +158,12 @@ rejected.
Comments are very important. Not only are they are an aid to the reader, but in many
cases the comments specify the contract against which the code is evaluated.
Without a clear contract for a function, for example, it is *impossible* to determine
whether the function is implemented correclty.
whether the function is implemented correctly.
The following kinds of things should have comments.
## Components (`struct`'s and `trait`'s)
Comments for a component (`struct` or `trait`) should explain what the overall
## Components (`struct`'s, `trait`'s, and `enum`'s)
Comments for a component (`struct`, `trait`, or `enum`) should explain what the overall
purpose of that component is. This is usually a concept, and not a formal contract.
Help the reader understand why this group of data or methods are grouped
@@ -190,7 +190,7 @@ or return an empty value.
Example:
```
```rust
pub trait BurnStateDB {
/// Returns the *header hash* of the burnchain block at the
/// burnchain height `height` in sortition `sortition_id`.