-
Notifications
You must be signed in to change notification settings - Fork 475
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
improve network.env comment verbosity #1185
improve network.env comment verbosity #1185
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think comments should be directly adjacent to the line they describe, but otherwise this PR looks good. Thanks for adding clarity!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you still need to squash your commits together, but the content looks good to me
ENABLE_WS=true # ENABLE_WS enables or disables websocket API. | ||
ENABLE_ARCHIVE=false # ENABLE_ARCHIVE enables or disables running an archive node. | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extra linebreak?
RUN_BLAKE3=false | ||
|
||
# Database Variable | ||
|
||
DB_ENGINE=leveldb |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would add "specify whether to use pebble or leveldb as the database backend.
|
||
#Bootnode Specific Variables | ||
#Should only be used by bootnode operators, i.e. team developers | ||
# a trusted communication channel. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitting so hard, but the only change on this line is an extra space.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple changes requested. Also I couldn't add as a comment but please add a space on line 16 (#Ports) since you're already here
14a3ef6
to
0b98e09
Compare
Closing because out of date |
Hello,
Back again with a PR to make things more understandable for users. In this PR I added comments and descriptors for many of the variables, reorganized some of the variables to fit into the correct categories, and removed stale variables (QUAI_MINING and ENABLE_UNLOCK).
If I was mistaken in removing either of the stale variables and they are still in use, please let me know!