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

addressing some comments

Browse Source
This commit is contained in:
Gregory Coppola
2021-08-17 10:39:03 -05:00
parent 759a4a8657
commit 4255be1698
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTORS.md
View File

@@ -160,10 +160,12 @@ 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 correctly.
Here are high level rules for creating comments:
- Use markdown to format comments, and use the triple backlash "///"
- Use markdown to format comments.
- Use the triple forward slash "///" for modules, structs, enums, traits and functions. Use double forward slash "//" for comments on individual lines of code.
- Start with a high-level description of the function, adding more sentences with details if necessary.
- For some functions, you might want to add a markdown section for panics, errors, none results, or for examples.
- Rust has explicit typing, so it most cases explicit documentation for input and outputs of functions is not necessary. However, if there is any ambiguity, document it in the function comment.
- Comments are not meant to recapitulate things that are obvious from the context, whether the type signature or otherwise. Use your best judgement to document that which is not obvious.
The following kinds of things should have comments.
## Components (`struct`'s, `trait`'s, and `enum`'s)