chore: document MinerConfig parameters #6019
Open
+328
−30
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wileyj
reviewed
Apr 16, 2025
wileyj
reviewed
Apr 16, 2025
wileyj
reviewed
May 6, 2025
wileyj
reviewed
May 9, 2025
stackslib/src/config/mod.rs
Outdated
| /// preventing potential starvation. A value of 0 means never prioritize them first, | ||
| /// 100 means always prioritize them first (if available). | ||
| /// | ||
| /// Default: 25 (25% chance) |
There was a problem hiding this comment.
Suggested change
| /// Default: 25 (25% chance) | |
| /// Default: `25` (25% chance) |
added backticks to the value to match other comments
There was a problem hiding this comment.
one small change - otherwise lgtm!
There was a problem hiding this comment.
added (to this and a couple of other parameters I missed) in 9bb8633
obycode
reviewed
May 12, 2025
stackslib/src/config/mod.rs
Outdated
| /// the mempool walk for block building. If this list is non-empty, any transaction whose | ||
| /// origin address is *not* in this set will be skipped. | ||
| /// | ||
| /// This allows miners (particularly "boosted" or "neutral" miners) to prioritize transactions |
There was a problem hiding this comment.
Let's remove this language about "boosted" or "neutral".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add documentation for all
MinerConfigparametersApplicable issues
Additional info (benefits, drawbacks, caveats)
Checklist
docs/rpc/openapi.yamlandrpc-endpoints.mdfor v2 endpoints,event-dispatcher.mdfor new events)clarity-benchmarkingrepobitcoin-tests.yml