I decided to fix any typos, grammar issues, or unclear comments as well as standardize the format of the comments while reading through the repo to gain a better understanding of how everything works. Nearly all changes are to comments only, however, there is one variable name that was renamed due to a typo.
All comments now start with a capital and any multi-line comments have better punctuation to be more easily read. This brings the comments format closer to what the rust foundation recommends and improves the overall readability. I tried to keep the content of each comment as close to the original as I could, however, there were a few comments that were very difficult to read and those were heavily changed.
Type of change
Please select the right one.
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Documentation update
Which part is impacted ?
[x] Daemon
[x] Wallet
[x] Miner
[x] Misc (documentation, comments, text...)
Checklist
[x] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
Description
I decided to fix any typos, grammar issues, or unclear comments as well as standardize the format of the comments while reading through the repo to gain a better understanding of how everything works. Nearly all changes are to comments only, however, there is one variable name that was renamed due to a typo.
All comments now start with a capital and any multi-line comments have better punctuation to be more easily read. This brings the comments format closer to what the rust foundation recommends and improves the overall readability. I tried to keep the content of each comment as close to the original as I could, however, there were a few comments that were very difficult to read and those were heavily changed.
Type of change
Please select the right one.
Which part is impacted ?
Checklist