Skip to content

feat(sysctl): Add helper command#620

Merged
msbrogli merged 1 commit intomasterfrom
feat/sysctl-help
May 19, 2023
Merged

feat(sysctl): Add helper command#620
msbrogli merged 1 commit intomasterfrom
feat/sysctl-help

Conversation

@msbrogli
Copy link
Member

@msbrogli msbrogli commented May 19, 2023

Acceptance criteria

  1. Add !help command, which shows all commands available.
  2. Add !help [cmd] command, which shows a help message for the command.

Example

!help
p2p.always_enable_sync
p2p.always_enable_sync.readtxt
p2p.force_sync_rotate
p2p.max_enabled_sync
p2p.rate_limit.global.send_tips
p2p.sync_update_interval
!help p2p.always_enable_sync
getter() -> List[str]:
    Return the list of sync-always-enabled peers.

setter(values: List[str]) -> None:
    Change the list of sync-always-enabled peers.
!help p2p.rate_limit.global.send_tips
getter() -> Tuple[int, float]:
    Return the global rate limiter for SEND_TIPS.

setter(max_hits: int, window_seconds: float) -> None:
    Change the global rate limiter for SEND_TIPS.

    The rate limiter is disabled when `window_seconds == 0`.

@msbrogli msbrogli requested a review from jansegre as a code owner May 19, 2023 18:03
@msbrogli msbrogli requested a review from glevco May 19, 2023 18:05
@msbrogli msbrogli self-assigned this May 19, 2023
@msbrogli msbrogli force-pushed the feat/sysctl-help branch from bceb3b8 to 3f2ec81 Compare May 19, 2023 18:08
@msbrogli msbrogli force-pushed the feat/sysctl-help branch from 3f2ec81 to d7508e0 Compare May 19, 2023 18:09
@codecov
Copy link

codecov bot commented May 19, 2023

Codecov Report

Merging #620 (d7508e0) into master (9ba84cc) will decrease coverage by 0.02%.
The diff coverage is 87.50%.

@@            Coverage Diff             @@
##           master     #620      +/-   ##
==========================================
- Coverage   83.62%   83.61%   -0.02%     
==========================================
  Files         232      232              
  Lines       19788    19826      +38     
  Branches     2707     2714       +7     
==========================================
+ Hits        16548    16577      +29     
- Misses       2640     2647       +7     
- Partials      600      602       +2     
Impacted Files Coverage Δ
hathor/sysctl/protocol.py 84.31% <85.71%> (+0.25%) ⬆️
hathor/sysctl/sysctl.py 100.00% <100.00%> (ø)

... and 3 files with indirect coverage changes

@msbrogli msbrogli merged commit d7508e0 into master May 19, 2023
@msbrogli msbrogli deleted the feat/sysctl-help branch May 19, 2023 19:09
@jansegre jansegre mentioned this pull request Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants