Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos, grammar, comment clarification and standardization. #85

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from

Conversation

Epsiloong
Copy link
Contributor

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.

  • 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)
  • Documentation update

Which part is impacted ?

  • Daemon
  • Wallet
  • Miner
  • Misc (documentation, comments, text...)

Checklist

  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant