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

Improve consistency and documentation of configuration API #528

Merged
merged 11 commits into from
Aug 25, 2023

Conversation

adzialocha
Copy link
Member

@adzialocha adzialocha commented Aug 25, 2023

  • Check consistency (code & text) across all places where we have configurations
  • Remove wildcards for block list config
  • Fix value_name in clap setup
  • Improve documentation
  • Do not connect to other relays when relay mode is enabled + give a warning
  • Show private key configuration on startup

📋 Checklist

  • Add tests that cover your changes
  • Add this PR to the Unreleased section in CHANGELOG.md
  • Link this PR to any issues it closes
  • New files contain a SPDX license header

@codecov
Copy link

codecov bot commented Aug 25, 2023

Codecov Report

Patch coverage: 75.00% and project coverage change: +0.01% 🎉

Comparison is base (99ed7e8) 92.21% compared to head (8479ae9) 92.23%.

❗ Current head 8479ae9 differs from pull request most recent head a6753c9. Consider uploading reports for the commit a6753c9 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #528      +/-   ##
==========================================
+ Coverage   92.21%   92.23%   +0.01%     
==========================================
  Files         102      102              
  Lines       16103    16103              
==========================================
+ Hits        14849    14852       +3     
+ Misses       1254     1251       -3     
Files Changed Coverage Δ
aquadoggo/src/network/behaviour.rs 44.95% <50.00%> (+0.91%) ⬆️
aquadoggo/src/config.rs 80.00% <100.00%> (ø)
aquadoggo/src/network/config.rs 100.00% <100.00%> (ø)

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@adzialocha adzialocha changed the title Config adjustments Improve consistency and documentation of configuration API Aug 25, 2023
@adzialocha adzialocha marked this pull request as ready for review August 25, 2023 14:15
@adzialocha adzialocha merged commit 8b1ba91 into main Aug 25, 2023
8 checks passed
@adzialocha adzialocha deleted the config-adjustments branch August 25, 2023 14:16
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