You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -226,7 +226,7 @@ Contributions should not contain `unsafe` blocks if at all possible.
226
226
## Documentation
227
227
228
228
* Each file must have a **copyright statement**.
229
-
* Any new non-test modules should have **module-level documentation** explaining what the module does, and how it fits into the blockchain as a whole ([example](https://github.com/stacks-network/stacks-blockchain/blob/4852d6439b473e24705f14b8af637aded33cb422/testnet/stacks-node/src/neon_node.rs#L17)).
229
+
* Any new non-test modules should have **module-level documentation** explaining what the module does, and how it fits into the blockchain as a whole ([example](https://github.com/stacks-network/stacks-core/blob/4852d6439b473e24705f14b8af637aded33cb422/testnet/stacks-node/src/neon_node.rs#L17)).
230
230
* Any new files must have some **top-of-file documentation** that describes what the contained code does, and how it fits into the overall module.
231
231
232
232
Within the source files, the following **code documentation** standards are expected:
@@ -247,7 +247,7 @@ Within the source files, the following **code documentation** standards are expe
247
247
handle I/O reads and writes in an "outer" function. The "outer"
248
248
function only does the needful I/O and passes the data into the
249
249
"inner" function. The "inner" function is often private, whereas
250
-
the "outer" function is often public. For example, [`inner_try_mine_microblock` and `try_mine_microblock`](https://github.com/stacks-network/stacks-blockchain/blob/4852d6439b473e24705f14b8af637aded33cb422/testnet/stacks-node/src/neon_node.rs#L1148-L1216).
250
+
the "outer" function is often public. For example, [`inner_try_mine_microblock` and `try_mine_microblock`](https://github.com/stacks-network/stacks-core/blob/4852d6439b473e24705f14b8af637aded33cb422/testnet/stacks-node/src/neon_node.rs#L1148-L1216).
251
251
252
252
## Refactoring
253
253
@@ -281,7 +281,7 @@ Within the source files, the following **code documentation** standards are expe
281
281
does not decode with the allotted resources, then no further
282
282
processing may be done and the data is discarded. For an example, see
283
283
how the parsing functions in the http module use `BoundReader` and
284
-
`MAX_PAYLOAD_LEN` in [http.rs](https://github.com/stacks-network/stacks-blockchain/blob/4852d6439b473e24705f14b8af637aded33cb422/src/net/http.rs#L2260-L2285).
284
+
`MAX_PAYLOAD_LEN` in [http.rs](https://github.com/stacks-network/stacks-core/blob/4852d6439b473e24705f14b8af637aded33cb422/src/net/http.rs#L2260-L2285).
285
285
286
286
***All network input reception is time-bound.** Every piece of code that ingests data _from the network_ must impose a maximum amount of time that ingestion can take. If the data takes too long to arrive, then it must be discarded without any further processing. There is no time bound for data ingested from disk or passed as an argument; this requirement is meant by the space-bound requirement.
287
287
@@ -303,7 +303,7 @@ Changes to the peer network should be deployed incrementally and tested by multi
303
303
304
304
Any PRs that claim to improve performance **must ship with reproducible benchmarks** that accurately measure the improvement. This data must also be reported in the PR submission.
305
305
306
-
For an example, see [PR #3075](https://github.com/stacks-network/stacks-blockchain/pull/3075).
306
+
For an example, see [PR #3075](https://github.com/stacks-network/stacks-core/pull/3075).
307
307
308
308
## Error Handling
309
309
@@ -597,7 +597,7 @@ Keep in mind that better variable names can reduce the need for comments, e.g.:
0 commit comments